tw5-typed 0.0.2 → 0.0.6

package/README.md

@@ -15,7 +15,7 @@ Add `tw5-typed` to your `tsconfig.json`'s `compilerOptions`
 ```json
 {
   "compilerOptions": {
-    "types": ["node", "tw5-typed"] /* Type declaration files to be included in compilation. */,
+    "types": ["node", "tw5-typed"] /* Type declaration files to be included in compilation. */
   }
 }
 ```
@@ -23,5 +23,15 @@ Add `tw5-typed` to your `tsconfig.json`'s `compilerOptions`
 Then you will have global types like `$tw` automatically. You can import the rest of the types using `import type` statement:
 
 ```typescript
-
+import type { ISearchOptions, SourceIterator, IFilterOperatorParamOperator } from 'tiddlywiki';
 ```
+
+## Development
+
+You can add new `*.d.ts` file to contain your types:
+
+1. use `declare module 'tiddlywiki' { }` to wrap all your types.
+1. don't forget to `export` all your types.
+1. to add type for global variable, add `global { }` inside that `declare module 'tiddlywiki' { }`, like `global { var $tw: I$TW; }`
+
+And add `import './xxx';` in the `index.d.ts` file.

package/package.json

@@ -2,9 +2,9 @@
   "description": "Types for tiddlywiki",
   "license": "MIT",
   "name": "tw5-typed",
-  "version": "0.0.2",
+  "version": "0.0.6",
   "url": "https://github.com/tiddly-gittly/tw5-typed",
-  "types": "index.d.ts",
+  "types": "src/index.d.ts",
   "files": [
     "src/"
   ],

package/src/filter-operator.d.ts

@@ -1,40 +1,42 @@
-export type SourceIterator = (tiddler: Object, title: string) => void;
-export interface ISearchOptions {
-  /** an iterator function for the source tiddlers, called source(iterator), where iterator is called as iterator(tiddler,title) */
-  source?: (iter: SourceIterator) => void;
-  /** An array of tiddler titles to exclude from the search */
-  exclude?: string[];
-  /** If true returns tiddlers that do not contain the specified string */
-  invert?: boolean;
-  /** If true forces a case sensitive search */
-  caseSensitive?: boolean;
-  /** If specified, restricts the search to the specified field, or an array of field names */
-  field?: string | string[];
-  /** If true, forces all but regexp searches to be anchored to the start of text */
-  anchored?: boolean;
-  /** If true, the field options are inverted to specify the fields that are not to be searched */
-  excludeField?: boolean;
-  /** searches for literal string */
-  literal?: boolean;
-  /** same as literal except runs of whitespace are treated as a single space */
-  whitespace?: boolean;
-  /** (default) treats search string as a list of tokens, and matches if all tokens are found, regardless of adjacency or ordering */
-  words?: boolean;
-}
+declare module 'tiddlywiki' {
+  export type SourceIterator = (tiddler: Object, title: string) => void;
+  export interface ISearchOptions {
+    /** an iterator function for the source tiddlers, called source(iterator), where iterator is called as iterator(tiddler,title) */
+    source?: (iter: SourceIterator) => void;
+    /** An array of tiddler titles to exclude from the search */
+    exclude?: string[];
+    /** If true returns tiddlers that do not contain the specified string */
+    invert?: boolean;
+    /** If true forces a case sensitive search */
+    caseSensitive?: boolean;
+    /** If specified, restricts the search to the specified field, or an array of field names */
+    field?: string | string[];
+    /** If true, forces all but regexp searches to be anchored to the start of text */
+    anchored?: boolean;
+    /** If true, the field options are inverted to specify the fields that are not to be searched */
+    excludeField?: boolean;
+    /** searches for literal string */
+    literal?: boolean;
+    /** same as literal except runs of whitespace are treated as a single space */
+    whitespace?: boolean;
+    /** (default) treats search string as a list of tokens, and matches if all tokens are found, regardless of adjacency or ordering */
+    words?: boolean;
+  }
 
-export interface IFilterOperatorParamOperator {
-  /** the name of the filter operator specified in the WikiText; */
-  operator: string;
-  /** the operand for the filter step (as a string; if the filter specified it in angle brackets or braces, the text reference or letiable name will have already been resolved); */
-  operand: string;
-  /** (optional) a string containing a single exclamation mark if the filter operator is to be negated; */
-  prefix?: string;
-  /** (optional) a string containing an additional filter argument (typically a tiddler field name) following the filter name (separated by a colon in the filter syntax); */
-  suffix?: string;
-  /** multiple suffix
-   * for example, in `search:<field list>:<flag list>[<operand>]`, you will get `<field list>` as suffixes[0], and `<flag list>` as suffixes[1]
-   */
-  suffixes?: string[][];
-  /** (optional, deprecated) used instead of `operand` if the filter operand is a regexp. */
-  regexp?: string;
+  export interface IFilterOperatorParamOperator {
+    /** the name of the filter operator specified in the WikiText; */
+    operator: string;
+    /** the operand for the filter step (as a string; if the filter specified it in angle brackets or braces, the text reference or letiable name will have already been resolved); */
+    operand: string;
+    /** (optional) a string containing a single exclamation mark if the filter operator is to be negated; */
+    prefix?: string;
+    /** (optional) a string containing an additional filter argument (typically a tiddler field name) following the filter name (separated by a colon in the filter syntax); */
+    suffix?: string;
+    /** multiple suffix
+     * for example, in `search:<field list>:<flag list>[<operand>]`, you will get `<field list>` as suffixes[0], and `<flag list>` as suffixes[1]
+     */
+    suffixes?: string[][];
+    /** (optional, deprecated) used instead of `operand` if the filter operand is a regexp. */
+    regexp?: string;
+  }
 }

package/src/index.d.ts

@@ -1,16 +1,6 @@
-import { I$TW } from './tw';
+import './tw';
 import './filter-operator';
 
-declare module 'tiddlywiki' {
-  export * from './tw';
-  export * from './filter-operator';
-}
-
-// this only work when there is no import statement...
-// declare module '@tiddlygit/tiddlywiki' {
-//   export * from 'tiddlywiki';
-// }
-
-declare global {
-  var $tw: I$TW;
+declare module '@tiddlygit/tiddlywiki' {
+  export * from 'tiddlywiki';
 }

package/src/tw.d.ts

@@ -1,45 +1,55 @@
-export interface ITiddler {
-  cache: ITiddlerCache;
-  fields: ITiddlerFields;
-}
+declare module 'tiddlywiki' {
+  export interface ITiddler {
+    cache: ITiddlerCache;
+    fields: ITiddlerFields;
+  }
 
-export interface ITiddlerFields {
-  created: string;
-  list: string[];
-  modified: string;
-  tags: string[];
-  text: string;
-  title: string;
-  type: string;
-}
+  export interface ITiddlerFields {
+    created: string;
+    list: string[];
+    modified: string;
+    tags: string[];
+    text: string;
+    title: string;
+    type: string;
+    [anyKey: string]: unknown;
+  }
 
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface ITiddlerCache {}
+  // eslint-disable-next-line @typescript-eslint/no-empty-interface
+  export interface ITiddlerCache {}
 
-/**
- * filepath: '/Users/linonetwo/xxxx/wiki/Meme-of-LinOnetwo/tiddlers/tiddlerTitle.tid',
- * hasMetaFile: false
- * tiddlerTitle: string,
- * type: 'application/x-tiddler',
- */
-export interface IBootFilesIndexItem {
-  filepath: string;
-  hasMetaFile: boolean;
-  tiddlerTitle: string;
-  type: string;
-}
-/**
- * Record<tiddlerTitle, IBootFilesIndexItem>
- */
-export type IBootFilesIndex = Partial<Record<string, IBootFilesIndexItem>>;
+  /**
+   * filepath: '/Users/linonetwo/xxxx/wiki/Meme-of-LinOnetwo/tiddlers/tiddlerTitle.tid',
+   * hasMetaFile: false
+   * tiddlerTitle: string,
+   * type: 'application/x-tiddler',
+   */
+  export interface IBootFilesIndexItem {
+    filepath: string;
+    hasMetaFile: boolean;
+    tiddlerTitle: string;
+    type: string;
+  }
+  /**
+   * Record<tiddlerTitle, IBootFilesIndexItem>
+   */
+  export type IBootFilesIndex = Partial<Record<string, IBootFilesIndexItem>>;
+
+  export interface I$TW {
+    boot: { argv: string[]; files: IBootFilesIndex; startup: (options: { callback?: () => unknown }) => void };
+    hooks: { addHook: (hookName: string, callback: (...arguments_: any[]) => unknown) => void };
+    wiki: {
+      getTiddler: (title: string) => ITiddler | undefined;
+      /**
+       * Get full list of tiddler titles in the wiki
+       */
+      getTiddlers: () => string[];
+    };
+    utils: Record<string, any>;
+  }
+  export function TiddlyWiki(): I$TW;
 
-export interface I$TW {
-  boot: { argv: string[]; files: IBootFilesIndex; startup: (options: { callback?: () => unknown }) => void };
-  hooks: { addHook: (hookName: string, callback: (...arguments_: any[]) => unknown) => void };
-  wiki: {
-    getTiddler: (title: string) => ITiddler | undefined;
-    getTiddlers: () => ITiddler[];
-  };
-  utils: Record<string, any>;
+  global {
+    var $tw: I$TW;
+  }
 }
-export function TiddlyWiki(): I$TW;