diff --git a/index.d.ts b/index.d.ts index 0fc292b..d8c3272 100644 --- a/index.d.ts +++ b/index.d.ts @@ -60,7 +60,7 @@ export interface ShuffleOptions { * Shuffle can be isInitialized with a sort object. It is the same object * given to the sort method. */ - initialSort?: object; + initialSort?: SortOptions; /** * Whether to center grid items in the row with the leftover space. @@ -225,7 +225,7 @@ declare class Shuffle { * Returns styles which will be applied to the an item for a transition. * @param {object} obj Transition options. */ - protected getStylesForTransition(obj: { item: Shuffle.ShuffleItem, styles: CSSStyleDeclaration }): object; + protected getStylesForTransition(obj: { item: Shuffle.ShuffleItem, styles: InlineCssStyles }): InlineCssStyles; /** * Mutate positions before they're applied. @@ -274,8 +274,8 @@ declare class Shuffle { /** ShuffleItems being kept track of */ items: Shuffle.ShuffleItem[]; - lastFilter: any; - lastSort: any; + lastFilter: FilterArg; + lastSort: SortOptions; /** Current (merged) options */ options: ShuffleOptions; @@ -325,7 +325,7 @@ declare namespace Shuffle { class ShuffleItem { constructor(element: HTMLElement); addClasses(classes: string[]): void; - applyCss(obj: object): void; + applyCss(obj: InlineCssStyles): void; dispose(): void; hide(): void; init(): void; diff --git a/package.json b/package.json index ca21857..cda1b36 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,7 @@ "gulp": "gulp", "build": "npm run gulp && npm run css", "serve": "gulp jekyll", - "test": "eslint src && jest", + "test": "eslint src && jest && tsc --project ./test/types", "watch": "gulp watch" }, "repository": { @@ -66,6 +66,7 @@ "rollup-plugin-commonjs": "^10.0.0", "rollup-plugin-node-resolve": "^5.0.0", "rollup-plugin-terser": "^5.0.0", - "sinon": "^7.3.2" + "sinon": "^7.3.2", + "typescript": "^3.5.1" } } diff --git a/test/types/tsconfig.json b/test/types/tsconfig.json new file mode 100644 index 0000000..6ae1877 --- /dev/null +++ b/test/types/tsconfig.json @@ -0,0 +1,63 @@ +{ + "compilerOptions": { + /* Basic Options */ + // "incremental": true, /* Enable incremental compilation */ + "target": "ES2018", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */ + // "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */ + // "lib": [], /* Specify library files to be included in the compilation. */ + // "allowJs": true, /* Allow javascript files to be compiled. */ + // "checkJs": true, /* Report errors in .js files. */ + // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ + // "declaration": true, /* Generates corresponding '.d.ts' file. */ + // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ + // "sourceMap": true, /* Generates corresponding '.map' file. */ + // "outFile": "./", /* Concatenate and emit output to single file. */ + // "outDir": "./build" /* Redirect output structure to the directory. */ + // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ + // "composite": true, /* Enable project compilation */ + // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ + // "removeComments": true, /* Do not emit comments to output. */ + // "noEmit": true, /* Do not emit outputs. */ + // "importHelpers": true, /* Import emit helpers from 'tslib'. */ + // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ + // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ + + /* Strict Type-Checking Options */ + "strict": true, /* Enable all strict type-checking options. */ + "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ + "strictNullChecks": true, /* Enable strict null checks. */ + "strictFunctionTypes": true, /* Enable strict checking of function types. */ + "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ + "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ + "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */ + "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ + + /* Additional Checks */ + // "noUnusedLocals": true, /* Report errors on unused locals. */ + // "noUnusedParameters": true, /* Report errors on unused parameters. */ + // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ + // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ + + /* Module Resolution Options */ + "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ + // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */ + // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ + // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ + // "typeRoots": [], /* List of folders to include type definitions from. */ + // "types": [], /* Type declaration files to be included in compilation. */ + // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ + "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ + // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + + /* Source Map Options */ + // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ + // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ + + /* Experimental Options */ + // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ + // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ + } +} diff --git a/test/types/types.js b/test/types/types.js new file mode 100644 index 0000000..356de9c --- /dev/null +++ b/test/types/types.js @@ -0,0 +1,38 @@ +import Shuffle from '../../'; +Shuffle.ALL_ITEMS = 'item'; +Shuffle.FILTER_ATTRIBUTE_KEY = 'categories'; +const mainElement = document.getElementById('grid'); +if (!mainElement) { + throw new TypeError('oopsie'); +} +console.log(Shuffle.EventType.LAYOUT, Shuffle.Classes.SHUFFLE_ITEM, Shuffle.FilterMode.ALL, Shuffle.ShuffleItem.Css); +const options = { + buffer: 0, + columnThreshold: 0.01, + easing: 'ease-in-out', + itemSelector: '.picture-item', + sizer: '.my-sizer', + filterMode: Shuffle.FilterMode.ALL, +}; +const shuffle = new Shuffle(mainElement, options); +shuffle.filter('wallpaper'); +shuffle.filter(function filterEachItem(element, shuffle) { + console.log(`shuffle id: ${shuffle.id}, element id: ${element.id}`); + const reviews = this.getAttribute('data-reviews'); + return !!reviews && parseInt(reviews, 10) > 2; +}); +const sortOptions = { + randomize: true, + reverse: false, + by: (element) => element.getAttribute('data-reviews'), + compare(a, b) { + return 0; + }, +}; +shuffle.sort(sortOptions); +shuffle.update(true); +Shuffle.getSize(mainElement, true); +const rect1 = new Shuffle.Rect(0, 0, 20, 20); +const rect2 = new Shuffle.Rect(10, 10, 30, 30); +console.log(Shuffle.Rect.intersects(rect1, rect2)); +export default shuffle; diff --git a/test/types/types.ts b/test/types/types.ts new file mode 100644 index 0000000..88a98d5 --- /dev/null +++ b/test/types/types.ts @@ -0,0 +1,52 @@ +import Shuffle, { ShuffleOptions, SortOptions } from '../../'; + +Shuffle.ALL_ITEMS = 'item'; +Shuffle.FILTER_ATTRIBUTE_KEY = 'categories'; + +const mainElement = document.getElementById('grid'); + +if (!mainElement) { + throw new TypeError('oopsie'); +} + +console.log( + Shuffle.EventType.LAYOUT, + Shuffle.Classes.SHUFFLE_ITEM, + Shuffle.FilterMode.ALL, + Shuffle.ShuffleItem.Css, +); + +const options: ShuffleOptions = { + buffer: 0, + columnThreshold: 0.01, + easing: 'ease-in-out', + itemSelector: '.picture-item', + sizer: '.my-sizer', + filterMode: Shuffle.FilterMode.ALL, +}; +const shuffle = new Shuffle(mainElement, options); +shuffle.filter('wallpaper'); +shuffle.filter(function filterEachItem(element, shuffle) { + console.log(`shuffle id: ${shuffle.id}, element id: ${element.id}`); + const reviews = this.getAttribute('data-reviews'); + return !!reviews && parseInt(reviews, 10) > 2; +}); + +const sortOptions: SortOptions = { + randomize: true, + reverse: false, + by: (element: Shuffle.ShuffleItem['element']) => element.getAttribute('data-reviews'), + compare(a: Shuffle.ShuffleItem, b: Shuffle.ShuffleItem) { + return 0; + }, +}; +shuffle.sort(sortOptions); + +shuffle.update(true); +Shuffle.getSize(mainElement, true); + +const rect1 = new Shuffle.Rect(0, 0, 20, 20); +const rect2 = new Shuffle.Rect(10, 10, 30, 30); +console.log(Shuffle.Rect.intersects(rect1, rect2)); + +export default shuffle;