feat: add types

Author: cossssmin

package.json

@@ -8,6 +8,11 @@
   "homepage": "https://github.com/posthtml/posthtml-fetch",
   "repository": "posthtml/posthtml-fetch",
   "main": "lib",
+  "types": "types/index.d.ts",
+  "files": [
+    "lib",
+    "types"
+  ],
   "engines": {
     "node": ">=14.0.0"
   },
@@ -18,9 +23,6 @@
     "test": "vitest run --coverage",
     "lint": "biome lint ./lib ./test"
   },
-  "files": [
-    "lib"
-  ],
   "keywords": [
     "html",
     "posthtml",

types/expressions.d.ts

@@ -0,0 +1,100 @@
+export default interface ExpressionsConfig {
+  /**
+  Define the starting and ending delimiters used for expressions.
+
+  @default ['{{', '}}']
+  */
+  delimiters?: string[];
+
+  /**
+  Define the starting and ending delimiters used for unescaped expressions.
+
+  @default ['{{{', '}}}']
+  */
+  unescapeDelimiters?: string[];
+
+  /**
+  Object containing data that will be available under the `page` object.
+
+  @default {}
+  */
+  locals?: Record<string, unknown>;
+
+  /**
+  Attribute name for `<script>` tags that contain locals.
+
+  @default 'locals'
+  */
+  localsAttr?: string;
+
+  /**
+  Whether to remove `<script>` tags that contain locals.
+
+  @default false
+  */
+  removeScriptLocals?: boolean;
+
+  /**
+  Tag names to be used for if/else statements.
+
+  @default ['if', 'elseif', 'else']
+  */
+  conditionalTags?: string[];
+
+  /**
+  Tag names to be used for switch statements.
+
+  @default ['switch', 'case', 'default']
+  */
+  switchTags?: string[];
+
+  /**
+  Tag names to be used for loops.
+
+  @default ['each', 'for']
+  */
+  loopTags?: string[];
+
+  /**
+  Tag names to be used for scopes.
+
+  @default ['scope']
+  */
+  scopeTags?: string[];
+
+  /**
+  Name of tag inside of which expression parsing is disabled.
+
+  @default 'raw'
+  */
+  ignoredTag?: string;
+
+  /**
+  Enabling strict mode will throw an error if an expression cannot be evaluated.
+
+  @default false
+  */
+  strictMode?: boolean;
+
+  /**
+  What to render when referencing a value that is not defined in `locals`.
+
+  By default, the string 'undefined' will be output.
+
+  @default undefined
+
+  @example
+
+  ```
+  // Output empty string if value is not defined
+  missingLocal: ''
+
+  // Output original reference if value is not defined
+  missingLocal: '{local}'
+
+  // Output custom string if value is not defined
+  missingLocal: 'ERR_NO_VALUE: {local}'
+  ```
+  */
+  missingLocal?: string;
+}

types/index.d.ts

@@ -0,0 +1,41 @@
+import type { $Fetch } from "ofetch";
+import type ExpressionsConfig from "./expressions";
+
+export type PostHTMLFetchConfig = {
+  /**
+  String representing the attribute name containing the URL to fetch.
+
+  @default 'url'
+  */
+  attribute?: string;
+  /**
+  `posthtml-expressions` is used to evaluate expressions.
+
+  You may pass options directly to it, inside the `expressions` object.
+
+  @default {}
+  */
+  expressions?: ExpressionsConfig;
+  /**
+  `posthtml-fetch` uses `ofetch` to fetch data.
+
+  You may pass options directly to it, inside the `ofetch` object.
+
+  @default {}
+  */
+  ofetch?: $Fetch;
+  /**
+  Set this to `true` if you need to preserve the `tag`, i.e. `<fetch>` around the response body.
+
+  @default false
+  */
+  preserveTag?: boolean;
+  /**
+  Supported tag names.
+
+  Only tags from this array will be processed by the plugin.
+
+  @default ['fetch', 'remote']
+  */
+  tags: string[];
+};