tw5-typed 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Tiddly Gittly
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,2 @@
+# TW5-Typed
+TypeScript type definitions for TiddlyWiki5.

package/package.json

@@ -0,0 +1,16 @@
+{
+  "description": "Types for tiddlywiki",
+  "license": "MIT",
+  "name": "tw5-typed",
+  "version": "0.0.1",
+  "url": "https://github.com/tiddly-gittly/tw5-typed",
+  "types": "src/index.d.ts",
+  "author": "",
+  "scripts": {
+  },
+  "devDependencies": {
+    "typescript": "^4.5.5"
+  },
+  "dependencies": {
+  }
+}

package/src/filter-operator.d.ts

@@ -0,0 +1,40 @@
+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;
+}

package/src/index.d.ts

@@ -0,0 +1,16 @@
+import { I$TW } from './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;
+}

package/src/tw.d.ts

@@ -0,0 +1,43 @@
+export interface ITiddler {
+  cache: ITiddlerCache;
+  fields: ITiddlerFields;
+}
+
+export interface ITiddlerFields {
+  created: string;
+  list: string[];
+  modified: string;
+  tags: string[];
+  text: string;
+  title: string;
+  type: string;
+}
+
+// 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>>;
+
+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;
+  };
+}
+export function TiddlyWiki(): I$TW;