@starlightcms/js-sdk 0.9.0 → 0.11.0

package/README.md

@@ -0,0 +1,54 @@
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="/website/static/img/sdk-header-dark.svg">
+  <source media="(prefers-color-scheme: light)" srcset="/website/static/img/sdk-header.svg">
+  <img alt="Starlight JS SDK logo" src="/website/static/img/sdk-header.svg">
+</picture>
+
+# Starlight JavaScript SDK
+
+This is the official Starlight SDK for websites and JavaScript applications, which makes integrating Starlight
+content into your apps a real breeze.
+
+You can read the usage guide and the API reference in [its documentation page](https://js.sdk.starlight.sh).
+
+## Quick Start
+
+To quickly start using the JS SDK, install it into your project:
+
+```shell
+npm install @starlightcms/js-sdk
+```
+
+Then, import the SDK and configure which Starlight workspace it should request data from:
+
+```js
+import Starlight from '@starlightcms/js-sdk'
+
+Starlight.configure({
+  workspace: '1234567890'
+})
+```
+
+And, finally, start requesting data:
+
+```js
+import Starlight from '@starlightcms/js-sdk'
+
+// Listing all entries from the 'posts' model.
+const response = Starlight.posts.entries.list()
+
+// Getting content from the 'hello-world' entry.
+const response = Starlight.posts.entries.get('hello-world')
+```
+
+The SDK is capable of requesting a myriad of different content from your workspaces. Check out 
+[the documentation](https://js.sdk.starlight.sh/docs/intro) to learn more.
+
+## React SDK
+
+If you use React on your application, take a look at [the Starlight React SDK](https://github.com/starlightcms/react-sdk).
+It's based in the JS SDK, and also provide useful React components to simplify content and image rendering.
+
+## Issues
+
+If you have any questions or you're facing any issues with the SDK, feel free to [open an issue](https://github.com/starlightcms/js-sdk/issues).

package/dist/cjs/client.d.ts

@@ -1,3 +1,42 @@
-import { DefaultModelDefinition, ProxiedStarlightClient, StarlightConfig, WorkspaceModelDefinition } from './types';
-export declare function makeClient<D extends WorkspaceModelDefinition = DefaultModelDefinition>(config?: StarlightConfig): ProxiedStarlightClient<D>;
+import { DefaultModelDefinition, DynamicStarlightClient, StarlightConfig, WorkspaceModelDefinition } from './types';
+/**
+ * Returns a new {@link DynamicStarlightClient}, which is a
+ * {@link StarlightClient} with support to create
+ * {@apilink ModelInstance | ModelInstances} using the dynamic syntax. To learn
+ * which methods a client supports, see {@link StarlightClient}.
+ *
+ * This function accepts a {@link StarlightConfig} object and can be used to
+ * create new clients that connect to a single Starlight workspace. Each client
+ * returned by this function is separate and independent of the others.
+ *
+ * If you only need to make requests to a single workspace, it's probably easier
+ * to use the SDK's default client. To use it, you only need to
+ * import the default object exported by the SDK:
+ *
+ *  ```ts
+ * // `Starlight` below is the default StarlightClient.
+ * import Starlight from '@starlightcms/js-sdk'
+ * ```
+ *
+ * See {@link default} for more info on how to use the default client.
+ *
+ * @example Creating a new client and exporting it.
+ *  ```ts
+ * import { makeStarlightClient } from '@starlightcms/js-sdk'
+ *
+ * const BlogClient = makeStarlightClient({
+ *   workspace: '123123123',
+ *   debug: true
+ * })
+ *
+ * // Feel free to export the new client so your application can use it.
+ * export default BlogClient
+ * ```
+ *
+ * @param config The client configuration object. You need to provide at least
+ * the `workspace` property. See {@link StarlightConfig} to view all the
+ * available options.
+ * @group Client
+ */
+export declare function makeClient<D extends WorkspaceModelDefinition = DefaultModelDefinition>(config?: StarlightConfig): DynamicStarlightClient<D>;
 //# sourceMappingURL=client.d.ts.map

package/dist/cjs/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,sBAAsB,EAEtB,eAAe,EACf,wBAAwB,EACzB,MAAM,SAAS,CAAA;AAUhB,wBAAgB,UAAU,CACxB,CAAC,SAAS,wBAAwB,GAAG,sBAAsB,EAC3D,MAAM,GAAE,eAAoB,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAkFzD"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,sBAAsB,EAEtB,eAAe,EACf,wBAAwB,EACzB,MAAM,SAAS,CAAA;AAUhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAgB,UAAU,CACxB,CAAC,SAAS,wBAAwB,GAAG,sBAAsB,EAC3D,MAAM,GAAE,eAAoB,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAkFzD"}

package/dist/cjs/client.js

@@ -21,6 +21,45 @@ const Collection_1 = __importDefault(require("./selectors/Collection"));
 const Media_1 = __importDefault(require("./selectors/Media"));
 const Search_1 = __importDefault(require("./selectors/Search"));
 const Collection_2 = __importDefault(require("./instances/Collection"));
+/**
+ * Returns a new {@link DynamicStarlightClient}, which is a
+ * {@link StarlightClient} with support to create
+ * {@apilink ModelInstance | ModelInstances} using the dynamic syntax. To learn
+ * which methods a client supports, see {@link StarlightClient}.
+ *
+ * This function accepts a {@link StarlightConfig} object and can be used to
+ * create new clients that connect to a single Starlight workspace. Each client
+ * returned by this function is separate and independent of the others.
+ *
+ * If you only need to make requests to a single workspace, it's probably easier
+ * to use the SDK's default client. To use it, you only need to
+ * import the default object exported by the SDK:
+ *
+ *  ```ts
+ * // `Starlight` below is the default StarlightClient.
+ * import Starlight from '@starlightcms/js-sdk'
+ * ```
+ *
+ * See {@link default} for more info on how to use the default client.
+ *
+ * @example Creating a new client and exporting it.
+ *  ```ts
+ * import { makeStarlightClient } from '@starlightcms/js-sdk'
+ *
+ * const BlogClient = makeStarlightClient({
+ *   workspace: '123123123',
+ *   debug: true
+ * })
+ *
+ * // Feel free to export the new client so your application can use it.
+ * export default BlogClient
+ * ```
+ *
+ * @param config The client configuration object. You need to provide at least
+ * the `workspace` property. See {@link StarlightConfig} to view all the
+ * available options.
+ * @group Client
+ */
 function makeClient(config = {}) {
     var _a, _b, _c;
     let baseUrl = (_a = config.baseUrl) !== null && _a !== void 0 ? _a : 'https://query.starlight.sh/v2';

package/dist/cjs/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAOA,qCAAyC;AACzC,8DAAiD;AACjD,8DAAiD;AACjD,sEAAyD;AACzD,wEAA2D;AAC3D,8DAAiD;AACjD,gEAAmD;AACnD,wEAA2D;AAE3D,SAAgB,UAAU,CAExB,SAA0B,EAAE;;IAC5B,IAAI,OAAO,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,+BAA+B,CAAA;IAC/D,IAAI,SAAS,GAAG,MAAA,MAAM,CAAC,SAAS,mCAAI,EAAE,CAAA;IACtC,IAAI,KAAK,GAAG,MAAA,MAAM,CAAC,KAAK,mCAAI,KAAK,CAAA;IAEjC,MAAM,MAAM,GAAoB;QAC9B,SAAS,CAAC,MAAM;;YACd,OAAO,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,OAAO,CAAA;YACnC,SAAS,GAAG,MAAA,MAAM,CAAC,SAAS,mCAAI,SAAS,CAAA;YACzC,KAAK,GAAG,MAAA,MAAM,CAAC,KAAK,mCAAI,KAAK,CAAA;QAC/B,CAAC;QAED,GAAG,CAAC,OAAO,EAAE,GAAG,cAAc;YAC5B,IAAI,KAAK;gBAAE,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAA;QACpD,CAAC;QAED,UAAU;YACR,OAAO,GAAG,OAAO,eAAe,SAAS,EAAE,CAAA;QAC7C,CAAC;QAEK,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,EAAE,EAAE,OAAO;;gBAClC,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,GAAG,EAAE,EAAE;oBACrE,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;oBAEzB,IAAI,KAAK,IAAI,KAAK,KAAK,KAAK;wBAAE,WAAW,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;oBAE9D,OAAO,WAAW,CAAA;gBACpB,CAAC,EAAE,EAA4B,CAAC,CAAA;gBAEhC,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE,CAAA;gBACnE,MAAM,SAAS,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,YAAY,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;gBAEjE,IAAI,CAAC,GAAG,CAAC,mBAAmB,SAAS,EAAE,CAAC,CAAA;gBAExC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,UAAU,EAAE,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,CAAA;gBAEzE,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE;oBACnD,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;iBAC7B;qBAAM;oBACL,MAAM,OAAO,GAAG,mBAAmB,IAAI,aAAa,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAA;oBAC7F,MAAM,IAAI,uBAAc,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;iBAC5C;YACH,CAAC;SAAA;QAED,IAAI,MAAM;YACR,OAAO,IAAA,eAAiB,EAAC,IAAI,CAAC,CAAA;QAChC,CAAC;QAED,KAAK,CAAC,IAAI;YACR,OAAO,IAAA,eAAiB,EAAC,IAAI,EAAE,IAAc,CAAC,CAAA;QAChD,CAAC;QAED,IAAI,UAAU;YACZ,OAAO,IAAA,mBAAqB,EAAC,IAAI,CAAC,CAAA;QACpC,CAAC;QAED,IAAI,WAAW;YACb,OAAO,IAAA,oBAAsB,EAAC,IAAI,CAAC,CAAA;QACrC,CAAC;QAED,UAAU,CAAC,IAAqB;YAC9B,OAAO,IAAA,oBAAsB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAC3C,CAAC;QAED,IAAI,KAAK;YACP,OAAO,IAAA,eAAiB,EAAC,IAAI,CAAC,CAAA;QAChC,CAAC;QAED,IAAI,MAAM;YACR,OAAO,IAAA,gBAAkB,EAAC,IAAI,CAAC,CAAA;QACjC,CAAC;KACF,CAAA;IAED,OAAO,IAAI,KAAK,CAAC,MAAM,EAAE;QACvB,GAAG,CAAC,MAAM,EAAE,IAAI;YACd,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;gBAC1D,OAAO,IAAA,eAAiB,EAAC,MAAM,EAAE,IAAI,CAAC,CAAA;aACvC;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAA8B,CAAA;AACjC,CAAC;AApFD,gCAoFC","sourcesContent":["import {\n  DefaultModelDefinition,\n  ProxiedStarlightClient,\n  StarlightClient,\n  StarlightConfig,\n  WorkspaceModelDefinition,\n} from './types'\nimport { StarlightError } from './errors'\nimport makeModelSelector from './selectors/Model'\nimport makeModelInstance from './instances/Model'\nimport makeSingletonSelector from './selectors/Singleton'\nimport makeCollectionSelector from './selectors/Collection'\nimport makeMediaSelector from './selectors/Media'\nimport makeSearchSelector from './selectors/Search'\nimport makeCollectionInstance from './instances/Collection'\n\nexport function makeClient<\n  D extends WorkspaceModelDefinition = DefaultModelDefinition\n>(config: StarlightConfig = {}): ProxiedStarlightClient<D> {\n  let baseUrl = config.baseUrl ?? 'https://query.starlight.sh/v2'\n  let workspace = config.workspace ?? ''\n  let debug = config.debug ?? false\n\n  const client: StarlightClient = {\n    configure(config) {\n      baseUrl = config.baseUrl ?? baseUrl\n      workspace = config.workspace ?? workspace\n      debug = config.debug ?? debug\n    },\n\n    log(message, ...optionalParams) {\n      if (debug) console.log(message, ...optionalParams)\n    },\n\n    getBaseUrl() {\n      return `${baseUrl}/workspaces/${workspace}`\n    },\n\n    async get(path, params = {}, options) {\n      const filteredParams = Object.keys(params).reduce((accumulator, key) => {\n        const param = params[key]\n\n        if (param || param === false) accumulator[key] = String(param)\n\n        return accumulator\n      }, {} as Record<string, string>)\n\n      const searchParams = new URLSearchParams(filteredParams).toString()\n      const finalPath = searchParams ? `${path}?${searchParams}` : path\n\n      this.log(`Starlight - GET ${finalPath}`)\n\n      const response = await fetch(`${this.getBaseUrl()}${finalPath}`, options)\n\n      if (response.status >= 200 && response.status < 300) {\n        return await response.json()\n      } else {\n        const message = `Starlight - GET ${path} returned ${response.status}: ${response.statusText}`\n        throw new StarlightError(message, response)\n      }\n    },\n\n    get models() {\n      return makeModelSelector(this)\n    },\n\n    model(slug) {\n      return makeModelInstance(this, slug as string)\n    },\n\n    get singletons() {\n      return makeSingletonSelector(this)\n    },\n\n    get collections() {\n      return makeCollectionSelector(this)\n    },\n\n    collection(slug: string | number) {\n      return makeCollectionInstance(this, slug)\n    },\n\n    get media() {\n      return makeMediaSelector(this)\n    },\n\n    get search() {\n      return makeSearchSelector(this)\n    },\n  }\n\n  return new Proxy(client, {\n    get(target, prop) {\n      if (typeof prop === 'string' && !Reflect.has(target, prop)) {\n        return makeModelInstance(target, prop)\n      }\n\n      return Reflect.get(target, prop)\n    },\n  }) as ProxiedStarlightClient<D>\n}\n"]}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAOA,qCAAyC;AACzC,8DAAiD;AACjD,8DAAiD;AACjD,sEAAyD;AACzD,wEAA2D;AAC3D,8DAAiD;AACjD,gEAAmD;AACnD,wEAA2D;AAE3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,SAAgB,UAAU,CAExB,SAA0B,EAAE;;IAC5B,IAAI,OAAO,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,+BAA+B,CAAA;IAC/D,IAAI,SAAS,GAAG,MAAA,MAAM,CAAC,SAAS,mCAAI,EAAE,CAAA;IACtC,IAAI,KAAK,GAAG,MAAA,MAAM,CAAC,KAAK,mCAAI,KAAK,CAAA;IAEjC,MAAM,MAAM,GAAoB;QAC9B,SAAS,CAAC,MAAM;;YACd,OAAO,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,OAAO,CAAA;YACnC,SAAS,GAAG,MAAA,MAAM,CAAC,SAAS,mCAAI,SAAS,CAAA;YACzC,KAAK,GAAG,MAAA,MAAM,CAAC,KAAK,mCAAI,KAAK,CAAA;QAC/B,CAAC;QAED,GAAG,CAAC,OAAO,EAAE,GAAG,cAAc;YAC5B,IAAI,KAAK;gBAAE,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAA;QACpD,CAAC;QAED,UAAU;YACR,OAAO,GAAG,OAAO,eAAe,SAAS,EAAE,CAAA;QAC7C,CAAC;QAEK,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,EAAE,EAAE,OAAO;;gBAClC,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,GAAG,EAAE,EAAE;oBACrE,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;oBAEzB,IAAI,KAAK,IAAI,KAAK,KAAK,KAAK;wBAAE,WAAW,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;oBAE9D,OAAO,WAAW,CAAA;gBACpB,CAAC,EAAE,EAA4B,CAAC,CAAA;gBAEhC,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE,CAAA;gBACnE,MAAM,SAAS,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,YAAY,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;gBAEjE,IAAI,CAAC,GAAG,CAAC,mBAAmB,SAAS,EAAE,CAAC,CAAA;gBAExC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,UAAU,EAAE,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,CAAA;gBAEzE,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE;oBACnD,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;iBAC7B;qBAAM;oBACL,MAAM,OAAO,GAAG,mBAAmB,IAAI,aAAa,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAA;oBAC7F,MAAM,IAAI,uBAAc,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;iBAC5C;YACH,CAAC;SAAA;QAED,IAAI,MAAM;YACR,OAAO,IAAA,eAAiB,EAAC,IAAI,CAAC,CAAA;QAChC,CAAC;QAED,KAAK,CAAC,IAAI;YACR,OAAO,IAAA,eAAiB,EAAC,IAAI,EAAE,IAAc,CAAC,CAAA;QAChD,CAAC;QAED,IAAI,UAAU;YACZ,OAAO,IAAA,mBAAqB,EAAC,IAAI,CAAC,CAAA;QACpC,CAAC;QAED,IAAI,WAAW;YACb,OAAO,IAAA,oBAAsB,EAAC,IAAI,CAAC,CAAA;QACrC,CAAC;QAED,UAAU,CAAC,IAAqB;YAC9B,OAAO,IAAA,oBAAsB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAC3C,CAAC;QAED,IAAI,KAAK;YACP,OAAO,IAAA,eAAiB,EAAC,IAAI,CAAC,CAAA;QAChC,CAAC;QAED,IAAI,MAAM;YACR,OAAO,IAAA,gBAAkB,EAAC,IAAI,CAAC,CAAA;QACjC,CAAC;KACF,CAAA;IAED,OAAO,IAAI,KAAK,CAAC,MAAM,EAAE;QACvB,GAAG,CAAC,MAAM,EAAE,IAAI;YACd,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;gBAC1D,OAAO,IAAA,eAAiB,EAAC,MAAM,EAAE,IAAI,CAAC,CAAA;aACvC;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAA8B,CAAA;AACjC,CAAC;AApFD,gCAoFC","sourcesContent":["import {\n  DefaultModelDefinition,\n  DynamicStarlightClient,\n  StarlightClient,\n  StarlightConfig,\n  WorkspaceModelDefinition,\n} from './types'\nimport { StarlightError } from './errors'\nimport makeModelSelector from './selectors/Model'\nimport makeModelInstance from './instances/Model'\nimport makeSingletonSelector from './selectors/Singleton'\nimport makeCollectionSelector from './selectors/Collection'\nimport makeMediaSelector from './selectors/Media'\nimport makeSearchSelector from './selectors/Search'\nimport makeCollectionInstance from './instances/Collection'\n\n/**\n * Returns a new {@link DynamicStarlightClient}, which is a\n * {@link StarlightClient} with support to create\n * {@apilink ModelInstance | ModelInstances} using the dynamic syntax. To learn\n * which methods a client supports, see {@link StarlightClient}.\n *\n * This function accepts a {@link StarlightConfig} object and can be used to\n * create new clients that connect to a single Starlight workspace. Each client\n * returned by this function is separate and independent of the others.\n *\n * If you only need to make requests to a single workspace, it's probably easier\n * to use the SDK's default client. To use it, you only need to\n * import the default object exported by the SDK:\n *\n *  ```ts\n * // `Starlight` below is the default StarlightClient.\n * import Starlight from '@starlightcms/js-sdk'\n * ```\n *\n * See {@link default} for more info on how to use the default client.\n *\n * @example Creating a new client and exporting it.\n *  ```ts\n * import { makeStarlightClient } from '@starlightcms/js-sdk'\n *\n * const BlogClient = makeStarlightClient({\n *   workspace: '123123123',\n *   debug: true\n * })\n *\n * // Feel free to export the new client so your application can use it.\n * export default BlogClient\n * ```\n *\n * @param config The client configuration object. You need to provide at least\n * the `workspace` property. See {@link StarlightConfig} to view all the\n * available options.\n * @group Client\n */\nexport function makeClient<\n  D extends WorkspaceModelDefinition = DefaultModelDefinition\n>(config: StarlightConfig = {}): DynamicStarlightClient<D> {\n  let baseUrl = config.baseUrl ?? 'https://query.starlight.sh/v2'\n  let workspace = config.workspace ?? ''\n  let debug = config.debug ?? false\n\n  const client: StarlightClient = {\n    configure(config) {\n      baseUrl = config.baseUrl ?? baseUrl\n      workspace = config.workspace ?? workspace\n      debug = config.debug ?? debug\n    },\n\n    log(message, ...optionalParams) {\n      if (debug) console.log(message, ...optionalParams)\n    },\n\n    getBaseUrl() {\n      return `${baseUrl}/workspaces/${workspace}`\n    },\n\n    async get(path, params = {}, options) {\n      const filteredParams = Object.keys(params).reduce((accumulator, key) => {\n        const param = params[key]\n\n        if (param || param === false) accumulator[key] = String(param)\n\n        return accumulator\n      }, {} as Record<string, string>)\n\n      const searchParams = new URLSearchParams(filteredParams).toString()\n      const finalPath = searchParams ? `${path}?${searchParams}` : path\n\n      this.log(`Starlight - GET ${finalPath}`)\n\n      const response = await fetch(`${this.getBaseUrl()}${finalPath}`, options)\n\n      if (response.status >= 200 && response.status < 300) {\n        return await response.json()\n      } else {\n        const message = `Starlight - GET ${path} returned ${response.status}: ${response.statusText}`\n        throw new StarlightError(message, response)\n      }\n    },\n\n    get models() {\n      return makeModelSelector(this)\n    },\n\n    model(slug) {\n      return makeModelInstance(this, slug as string)\n    },\n\n    get singletons() {\n      return makeSingletonSelector(this)\n    },\n\n    get collections() {\n      return makeCollectionSelector(this)\n    },\n\n    collection(slug: string | number) {\n      return makeCollectionInstance(this, slug)\n    },\n\n    get media() {\n      return makeMediaSelector(this)\n    },\n\n    get search() {\n      return makeSearchSelector(this)\n    },\n  }\n\n  return new Proxy(client, {\n    get(target, prop) {\n      if (typeof prop === 'string' && !Reflect.has(target, prop)) {\n        return makeModelInstance(target, prop)\n      }\n\n      return Reflect.get(target, prop)\n    },\n  }) as DynamicStarlightClient<D>\n}\n"]}

package/dist/cjs/errors.d.ts

@@ -1,4 +1,39 @@
+/**
+ * This error is thrown every time a problem occurs when requesting something
+ * from Starlight's APIs. When it does, you can inspect the attached response
+ * to verify what kind of problem happened and handle it accordingly.
+ *
+ * @group Errors
+ */
 export declare class StarlightError extends Error {
+    /**
+     * The response provided by the `fetch` method when the error occurred.
+     *
+     * @example Using the `response` property to handle 404 errors.
+     *
+     * ```ts
+     * import Starlight, { StarlightError } from '@starlightcms/js-sdk'
+     *
+     * // Returns either an Entry, null on 404 errors, or false in all other cases
+     * const requestEntry = async (slug) => {
+     *   try {
+     *     const response = await Starlight.posts.entries.get(slug)
+     *
+     *     return response.data
+     *   } catch (error) {
+     *     if (error instanceof StarlightError && error.response.status === 404) {
+     *       // Return null to indicate a 404 error
+     *       return null
+     *     }
+     *
+     *     // Return false in all other error scenarios
+     *     return false
+     *   }
+     * }
+     * ```
+     *
+     * @see [MDN documentation on the Response object](https://developer.mozilla.org/en-US/docs/Web/API/Response)
+     */
     response: Response;
     constructor(message: string, response: Response);
 }

package/dist/cjs/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,cAAe,SAAQ,KAAK;IAChC,QAAQ,EAAE,QAAQ,CAAA;gBAEb,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ;CAIhD"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,qBAAa,cAAe,SAAQ,KAAK;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACI,QAAQ,EAAE,QAAQ,CAAA;gBAEb,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ;CAIhD"}

package/dist/cjs/errors.js

@@ -1,6 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StarlightError = void 0;
+/**
+ * This error is thrown every time a problem occurs when requesting something
+ * from Starlight's APIs. When it does, you can inspect the attached response
+ * to verify what kind of problem happened and handle it accordingly.
+ *
+ * @group Errors
+ */
 class StarlightError extends Error {
     constructor(message, response) {
         super(message);

package/dist/cjs/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":";;;AAAA,MAAa,cAAe,SAAQ,KAAK;IAGvC,YAAY,OAAe,EAAE,QAAkB;QAC7C,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC1B,CAAC;CACF;AAPD,wCAOC","sourcesContent":["export class StarlightError extends Error {\n  public response: Response\n\n  constructor(message: string, response: Response) {\n    super(message)\n    this.response = response\n  }\n}\n"]}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":";;;AAAA;;;;;;GAMG;AACH,MAAa,cAAe,SAAQ,KAAK;IA+BvC,YAAY,OAAe,EAAE,QAAkB;QAC7C,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC1B,CAAC;CACF;AAnCD,wCAmCC","sourcesContent":["/**\n * This error is thrown every time a problem occurs when requesting something\n * from Starlight's APIs. When it does, you can inspect the attached response\n * to verify what kind of problem happened and handle it accordingly.\n *\n * @group Errors\n */\nexport class StarlightError extends Error {\n  /**\n   * The response provided by the `fetch` method when the error occurred.\n   *\n   * @example Using the `response` property to handle 404 errors.\n   *\n   * ```ts\n   * import Starlight, { StarlightError } from '@starlightcms/js-sdk'\n   *\n   * // Returns either an Entry, null on 404 errors, or false in all other cases\n   * const requestEntry = async (slug) => {\n   *   try {\n   *     const response = await Starlight.posts.entries.get(slug)\n   *\n   *     return response.data\n   *   } catch (error) {\n   *     if (error instanceof StarlightError && error.response.status === 404) {\n   *       // Return null to indicate a 404 error\n   *       return null\n   *     }\n   *\n   *     // Return false in all other error scenarios\n   *     return false\n   *   }\n   * }\n   * ```\n   *\n   * @see [MDN documentation on the Response object](https://developer.mozilla.org/en-US/docs/Web/API/Response)\n   */\n  public response: Response\n\n  constructor(message: string, response: Response) {\n    super(message)\n    this.response = response\n  }\n}\n"]}

package/dist/cjs/index.d.ts

@@ -1,7 +1,28 @@
 import { makeClient } from './client';
 export { StarlightError } from './errors';
 export * from './types';
-declare const Starlight: import("./types").ProxiedStarlightClient<import("./types").DefaultModelDefinition>;
+/**
+ * This is the default object exported by the SDK module, which is a
+ * pre-created {@link StarlightClient}. In the docs, this is called the "global
+ * SDK client". If your application only requests data from a single Starlight
+ * workspace, using this client is easier than creating
+ * a new one using {@link makeStarlightClient}.
+ *
+ * Using the default client is as easy as importing the SDK:
+ *
+ * ```ts
+ * // "Starlight" below is the default client.
+ * import Starlight from '@starlightcms/js-sdk'
+ *
+ * const response = await Starlight.posts.entries.list()
+ * ```
+ *
+ * You need to configure the default workspace before using it.
+ * See {@apilink StarlightClient.configure} to learn more.
+ *
+ * @group Client
+ */
+declare const Starlight: import("./types").DynamicStarlightClient<import("./types").DefaultModelDefinition>;
 export { makeClient as makeStarlightClient };
 export default Starlight;
 //# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AACrC,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AACzC,cAAc,SAAS,CAAA;AAEvB,QAAA,MAAM,SAAS,oFAAe,CAAA;AAE9B,OAAO,EAAE,UAAU,IAAI,mBAAmB,EAAE,CAAA;AAE5C,eAAe,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AACrC,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AACzC,cAAc,SAAS,CAAA;AAEvB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,QAAA,MAAM,SAAS,oFAAe,CAAA;AAE9B,OAAO,EAAE,UAAU,IAAI,mBAAmB,EAAE,CAAA;AAE5C,eAAe,SAAS,CAAA"}

package/dist/cjs/index.js

@@ -20,6 +20,27 @@ Object.defineProperty(exports, "makeStarlightClient", { enumerable: true, get: f
 var errors_1 = require("./errors");
 Object.defineProperty(exports, "StarlightError", { enumerable: true, get: function () { return errors_1.StarlightError; } });
 __exportStar(require("./types"), exports);
+/**
+ * This is the default object exported by the SDK module, which is a
+ * pre-created {@link StarlightClient}. In the docs, this is called the "global
+ * SDK client". If your application only requests data from a single Starlight
+ * workspace, using this client is easier than creating
+ * a new one using {@link makeStarlightClient}.
+ *
+ * Using the default client is as easy as importing the SDK:
+ *
+ * ```ts
+ * // "Starlight" below is the default client.
+ * import Starlight from '@starlightcms/js-sdk'
+ *
+ * const response = await Starlight.posts.entries.list()
+ * ```
+ *
+ * You need to configure the default workspace before using it.
+ * See {@apilink StarlightClient.configure} to learn more.
+ *
+ * @group Client
+ */
 const Starlight = (0, client_1.makeClient)();
 exports.default = Starlight;
 //# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,qCAAqC;AAMd,oGANd,mBAAU,OAMuB;AAL1C,mCAAyC;AAAhC,wGAAA,cAAc,OAAA;AACvB,0CAAuB;AAEvB,MAAM,SAAS,GAAG,IAAA,mBAAU,GAAE,CAAA;AAI9B,kBAAe,SAAS,CAAA","sourcesContent":["import { makeClient } from './client'\nexport { StarlightError } from './errors'\nexport * from './types'\n\nconst Starlight = makeClient()\n\nexport { makeClient as makeStarlightClient }\n\nexport default Starlight\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,qCAAqC;AA2Bd,oGA3Bd,mBAAU,OA2BuB;AA1B1C,mCAAyC;AAAhC,wGAAA,cAAc,OAAA;AACvB,0CAAuB;AAEvB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,SAAS,GAAG,IAAA,mBAAU,GAAE,CAAA;AAI9B,kBAAe,SAAS,CAAA","sourcesContent":["import { makeClient } from './client'\nexport { StarlightError } from './errors'\nexport * from './types'\n\n/**\n * This is the default object exported by the SDK module, which is a\n * pre-created {@link StarlightClient}. In the docs, this is called the \"global\n * SDK client\". If your application only requests data from a single Starlight\n * workspace, using this client is easier than creating\n * a new one using {@link makeStarlightClient}.\n *\n * Using the default client is as easy as importing the SDK:\n *\n * ```ts\n * // \"Starlight\" below is the default client.\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.posts.entries.list()\n * ```\n *\n * You need to configure the default workspace before using it.\n * See {@apilink StarlightClient.configure} to learn more.\n *\n * @group Client\n */\nconst Starlight = makeClient()\n\nexport { makeClient as makeStarlightClient }\n\nexport default Starlight\n"]}

package/dist/cjs/instances/Collection/index.d.ts

@@ -1,5 +1,5 @@
-import { CollectionTypes, StarlightClient } from '../../types';
-import { CollectionInstance } from './types';
-export default function makeCollectionInstance<T extends CollectionTypes = string>(client: StarlightClient, collection: string | number): CollectionInstance<T>;
-export { CollectionInstance };
+import { CollectionEntityTypes, StarlightClient } from '../../types';
+import { CollectionInstance, ListCollectionItemsParams } from './types';
+export default function makeCollectionInstance<T extends CollectionEntityTypes = unknown>(client: StarlightClient, collection: string | number): CollectionInstance<T>;
+export { CollectionInstance, ListCollectionItemsParams };
 //# sourceMappingURL=index.d.ts.map

package/dist/cjs/instances/Collection/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/instances/Collection/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAE5C,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAC5C,CAAC,SAAS,eAAe,GAAG,MAAM,EAClC,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAU7E;AAED,OAAO,EAAE,kBAAkB,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/instances/Collection/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AACpE,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAA;AAEvE,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAC5C,CAAC,SAAS,qBAAqB,GAAG,OAAO,EACzC,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAU7E;AAED,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,CAAA"}

package/dist/cjs/instances/Collection/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/instances/Collection/index.ts"],"names":[],"mappings":";;AAGA,SAAwB,sBAAsB,CAE5C,MAAuB,EAAE,UAA2B;IACpD,OAAO;QACL,GAAG;YACD,OAAO,MAAM,CAAC,GAAG,CAAC,gBAAgB,UAAU,EAAE,CAAC,CAAA;QACjD,CAAC;QAED,KAAK,CAAC,OAAO;YACX,OAAO,MAAM,CAAC,GAAG,CAAC,gBAAgB,UAAU,QAAQ,EAAE,OAAO,CAAC,CAAA;QAChE,CAAC;KACF,CAAA;AACH,CAAC;AAZD,yCAYC","sourcesContent":["import { CollectionTypes, StarlightClient } from '../../types'\nimport { CollectionInstance } from './types'\n\nexport default function makeCollectionInstance<\n  T extends CollectionTypes = string\n>(client: StarlightClient, collection: string | number): CollectionInstance<T> {\n  return {\n    get() {\n      return client.get(`/collections/${collection}`)\n    },\n\n    items(options) {\n      return client.get(`/collections/${collection}/items`, options)\n    },\n  }\n}\n\nexport { CollectionInstance }\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/instances/Collection/index.ts"],"names":[],"mappings":";;AAGA,SAAwB,sBAAsB,CAE5C,MAAuB,EAAE,UAA2B;IACpD,OAAO;QACL,GAAG;YACD,OAAO,MAAM,CAAC,GAAG,CAAC,gBAAgB,UAAU,EAAE,CAAC,CAAA;QACjD,CAAC;QAED,KAAK,CAAC,OAAO;YACX,OAAO,MAAM,CAAC,GAAG,CAAC,gBAAgB,UAAU,QAAQ,EAAE,OAAO,CAAC,CAAA;QAChE,CAAC;KACF,CAAA;AACH,CAAC;AAZD,yCAYC","sourcesContent":["import { CollectionEntityTypes, StarlightClient } from '../../types'\nimport { CollectionInstance, ListCollectionItemsParams } from './types'\n\nexport default function makeCollectionInstance<\n  T extends CollectionEntityTypes = unknown\n>(client: StarlightClient, collection: string | number): CollectionInstance<T> {\n  return {\n    get() {\n      return client.get(`/collections/${collection}`)\n    },\n\n    items(options) {\n      return client.get(`/collections/${collection}/items`, options)\n    },\n  }\n}\n\nexport { CollectionInstance, ListCollectionItemsParams }\n"]}

package/dist/cjs/instances/Collection/types.d.ts

@@ -1,15 +1,71 @@
-import { Collection, CollectionTypes, ModelFieldOptions, SerializedData, StarlightItemResponse, StarlightListResponse } from '../../types';
-export declare type ListCollectionItemsOptions<T> = {
-    page?: number;
-    limit?: number;
-    query?: string;
-    'query:word'?: string;
-    fields?: string;
+import { BaseRequestParameters, Collection, CollectionEntityTypes, CollectionTypeMapper, QueryableRequestParameters, StarlightItemResponse, StarlightListResponse, WithQueryableFieldsOnModelables } from '../../types';
+/**
+ * Request parameters for listing collection items.
+ *
+ * Used by {@apilink CollectionInstance.items}.
+ *
+ * @group Request Parameters
+ */
+export interface ListCollectionItemsParams extends BaseRequestParameters, QueryableRequestParameters {
+    /**
+     * Define how entries will be ordered. Check this field type to see the
+     * allowed options.
+     */
     order?: 'title:asc' | 'title:desc' | 'published_at:asc' | 'published_at:desc' | 'views:asc' | 'views:desc';
-    except?: number;
-} & (T extends SerializedData ? ModelFieldOptions<T> : unknown);
-export interface CollectionInstance<C extends CollectionTypes = string> {
-    get(): Promise<StarlightItemResponse<Collection<C>>>;
-    items<T>(options?: ListCollectionItemsOptions<T>): Promise<StarlightListResponse<T>>;
+}
+/**
+ * An Instance that provide methods to request information and items from
+ * a specific {@link Collection}.
+ *
+ * You can access a CollectionInstance using
+ * {@apilink StarlightClient.collection}.
+ *
+ * To list all workspace collections, use a {@link CollectionSelector}.
+ *
+ * @group Instances
+ */
+export interface CollectionInstance<C extends CollectionEntityTypes> {
+    /**
+     * Returns a {@link StarlightItemResponse} with a single {@link Collection}.
+     *
+     * @example Requesting information from a collection of slug `featured-news`.
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.collection('featured-news').get()
+     * ```
+     */
+    get(): Promise<StarlightItemResponse<Collection<CollectionTypeMapper<C>>>>;
+    /**
+     * Returns a {@link StarlightListResponse} with the list of items of this
+     * {@link Collection}. The returned list type depends on the collection type:
+     * a list of {@apilink Entry | Entries} for a collection of type `entry`, a
+     * list of {@apilink MediaObject | MediaObjects} for a collection o type
+     * `media`, and so on.
+     *
+     * If the given Collection is not typed, this method will return a response of
+     * `StarlightListResponse<unknown>`.
+     *
+     * @example Requesting all items from an Entry collection of slug `featured-news`.
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.collection('featured-news').items()
+     * ```
+     *
+     * @example Explicitly typing the returned items. Only possible in TypeScript.
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     * import { NewsPostType } from '../types'
+     *
+     * // response will be StarlightListResponse<Entry<NewsPostType>>
+     * const response = await Starlight.collection<Entry<NewsPostType>>('featured-news').items()
+     * ```
+     *
+     * @param options An optional object of request parameters. See
+     * {@link ListCollectionItemsParams} for all available options. `field:foo`
+     * syntax is also supported, see {@link QueryableFields} for more info.
+     */
+    items(options?: ListCollectionItemsParams & WithQueryableFieldsOnModelables<C>): Promise<StarlightListResponse<C>>;
 }
 //# sourceMappingURL=types.d.ts.map

package/dist/cjs/instances/Collection/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/instances/Collection/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,eAAe,EACf,iBAAiB,EACjB,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB,oBAAY,0BAA0B,CAAC,CAAC,IAAI;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EACF,WAAW,GACX,YAAY,GACZ,kBAAkB,GAClB,mBAAmB,GACnB,WAAW,GACX,YAAY,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,GAAG,CAAC,CAAC,SAAS,cAAc,GAAG,iBAAiB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAA;AAE/D,MAAM,WAAW,kBAAkB,CAAC,CAAC,SAAS,eAAe,GAAG,MAAM;IACpE,GAAG,IAAI,OAAO,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACpD,KAAK,CAAC,CAAC,EACL,OAAO,CAAC,EAAE,0BAA0B,CAAC,CAAC,CAAC,GACtC,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAA;CACrC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/instances/Collection/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,UAAU,EACV,qBAAqB,EACrB,oBAAoB,EACpB,0BAA0B,EAC1B,qBAAqB,EACrB,qBAAqB,EACrB,+BAA+B,EAChC,MAAM,aAAa,CAAA;AAEpB;;;;;;GAMG;AACH,MAAM,WAAW,yBACf,SAAQ,qBAAqB,EAC3B,0BAA0B;IAC5B;;;OAGG;IACH,KAAK,CAAC,EACF,WAAW,GACX,YAAY,GACZ,kBAAkB,GAClB,mBAAmB,GACnB,WAAW,GACX,YAAY,CAAA;CACjB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,SAAS,qBAAqB;IACjE;;;;;;;;;OASG;IACH,GAAG,IAAI,OAAO,CAAC,qBAAqB,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAE1E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CACH,OAAO,CAAC,EAAE,yBAAyB,GAAG,+BAA+B,CAAC,CAAC,CAAC,GACvE,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAA;CACrC"}

package/dist/cjs/instances/Collection/types.js

@@ -1,3 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+0;
 //# sourceMappingURL=types.js.map

package/dist/cjs/instances/Collection/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/instances/Collection/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  Collection,\n  CollectionTypes,\n  ModelFieldOptions,\n  SerializedData,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\n\nexport type ListCollectionItemsOptions<T> = {\n  page?: number\n  limit?: number\n  query?: string\n  'query:word'?: string\n  fields?: string\n  order?:\n    | 'title:asc'\n    | 'title:desc'\n    | 'published_at:asc'\n    | 'published_at:desc'\n    | 'views:asc'\n    | 'views:desc'\n  except?: number\n} & (T extends SerializedData ? ModelFieldOptions<T> : unknown)\n\nexport interface CollectionInstance<C extends CollectionTypes = string> {\n  get(): Promise<StarlightItemResponse<Collection<C>>>\n  items<T>(\n    options?: ListCollectionItemsOptions<T>\n  ): Promise<StarlightListResponse<T>>\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/instances/Collection/types.ts"],"names":[],"mappings":";;AA4FA,CAAC,CAAA","sourcesContent":["import {\n  BaseRequestParameters,\n  Collection,\n  CollectionEntityTypes,\n  CollectionTypeMapper,\n  QueryableRequestParameters,\n  StarlightItemResponse,\n  StarlightListResponse,\n  WithQueryableFieldsOnModelables,\n} from '../../types'\n\n/**\n * Request parameters for listing collection items.\n *\n * Used by {@apilink CollectionInstance.items}.\n *\n * @group Request Parameters\n */\nexport interface ListCollectionItemsParams\n  extends BaseRequestParameters,\n    QueryableRequestParameters {\n  /**\n   * Define how entries will be ordered. Check this field type to see the\n   * allowed options.\n   */\n  order?:\n    | 'title:asc'\n    | 'title:desc'\n    | 'published_at:asc'\n    | 'published_at:desc'\n    | 'views:asc'\n    | 'views:desc'\n}\n\n/**\n * An Instance that provide methods to request information and items from\n * a specific {@link Collection}.\n *\n * You can access a CollectionInstance using\n * {@apilink StarlightClient.collection}.\n *\n * To list all workspace collections, use a {@link CollectionSelector}.\n *\n * @group Instances\n */\nexport interface CollectionInstance<C extends CollectionEntityTypes> {\n  /**\n   * Returns a {@link StarlightItemResponse} with a single {@link Collection}.\n   *\n   * @example Requesting information from a collection of slug `featured-news`.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.collection('featured-news').get()\n   * ```\n   */\n  get(): Promise<StarlightItemResponse<Collection<CollectionTypeMapper<C>>>>\n\n  /**\n   * Returns a {@link StarlightListResponse} with the list of items of this\n   * {@link Collection}. The returned list type depends on the collection type:\n   * a list of {@apilink Entry | Entries} for a collection of type `entry`, a\n   * list of {@apilink MediaObject | MediaObjects} for a collection o type\n   * `media`, and so on.\n   *\n   * If the given Collection is not typed, this method will return a response of\n   * `StarlightListResponse<unknown>`.\n   *\n   * @example Requesting all items from an Entry collection of slug `featured-news`.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.collection('featured-news').items()\n   * ```\n   *\n   * @example Explicitly typing the returned items. Only possible in TypeScript.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   * import { NewsPostType } from '../types'\n   *\n   * // response will be StarlightListResponse<Entry<NewsPostType>>\n   * const response = await Starlight.collection<Entry<NewsPostType>>('featured-news').items()\n   * ```\n   *\n   * @param options An optional object of request parameters. See\n   * {@link ListCollectionItemsParams} for all available options. `field:foo`\n   * syntax is also supported, see {@link QueryableFields} for more info.\n   */\n  items(\n    options?: ListCollectionItemsParams & WithQueryableFieldsOnModelables<C>\n  ): Promise<StarlightListResponse<C>>\n}\n0\n"]}

package/dist/cjs/instances/Model/index.d.ts

@@ -1,5 +1,5 @@
 import { SerializedData, StarlightClient } from '../../types';
-import { ProxiedModelInstance } from './types';
-export default function makeModelInstance<D extends SerializedData>(client: StarlightClient, model: string): ProxiedModelInstance<D>;
-export { ProxiedModelInstance };
+import { DynamicModelInstance, ModelInstance } from './types';
+export default function makeModelInstance<D extends SerializedData>(client: StarlightClient, model: string): DynamicModelInstance<D>;
+export { DynamicModelInstance, ModelInstance };
 //# sourceMappingURL=index.d.ts.map

package/dist/cjs/instances/Model/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/instances/Model/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,cAAc,EACd,eAAe,EAEhB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAS9C,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,CAAC,SAAS,cAAc,EAChE,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,MAAM,GACZ,oBAAoB,CAAC,CAAC,CAAC,CA4BzB;AAED,OAAO,EAAE,oBAAoB,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/instances/Model/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,cAAc,EACd,eAAe,EAEhB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAS7D,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,CAAC,SAAS,cAAc,EAChE,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,MAAM,GACZ,oBAAoB,CAAC,CAAC,CAAC,CA4BzB;AAED,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,CAAA"}

package/dist/cjs/instances/Model/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/instances/Model/index.ts"],"names":[],"mappings":";;;;;AAOA,kEAAwE;AACxE,kFAEsC;AACtC,qEAEyB;AAEzB,SAAwB,iBAAiB,CACvC,MAAuB,EACvB,KAAa;IAEb,MAAM,QAAQ,GAAG;QACf,GAAG;YACD,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,EAAE,CAAC,CAAA;QACvC,CAAC;QAED,QAAQ,CAAC,IAAY;YACnB,OAAO,IAAA,uBAAyB,EAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;QACvD,CAAC;QAED,IAAI,OAAO;YACT,OAAO,IAAA,eAAiB,EAAI,MAAM,EAAE,KAAK,CAAC,CAAA;QAC5C,CAAC;QAED,IAAI,UAAU;YACZ,OAAO,IAAA,uBAAyB,EAAC,MAAM,EAAE,KAAK,CAAC,CAAA;QACjD,CAAC;KACF,CAAA;IAED,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE;QACzB,GAAG,CAAC,MAAM,EAAE,IAAI;YACd,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;gBAC1D,OAAO,IAAA,uBAAyB,EAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;aACtD;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAA4B,CAAA;AAC/B,CAAC;AA/BD,oCA+BC","sourcesContent":["import {\n  Model,\n  SerializedData,\n  StarlightClient,\n  StarlightItemResponse,\n} from '../../types'\nimport { ProxiedModelInstance } from './types'\nimport makeEntrySelector, { EntrySelector } from '../../selectors/Entry'\nimport makeModelCategorySelector, {\n  ProxiedModelCategorySelector,\n} from '../../selectors/ModelCategory'\nimport makeModelCategoryInstance, {\n  ModelCategoryInstance,\n} from '../ModelCategory'\n\nexport default function makeModelInstance<D extends SerializedData>(\n  client: StarlightClient,\n  model: string\n): ProxiedModelInstance<D> {\n  const instance = {\n    get(): Promise<StarlightItemResponse<Model>> {\n      return client.get(`/models/${model}`)\n    },\n\n    category(slug: string): ModelCategoryInstance<D> {\n      return makeModelCategoryInstance(client, model, slug)\n    },\n\n    get entries(): EntrySelector<D> {\n      return makeEntrySelector<D>(client, model)\n    },\n\n    get categories(): ProxiedModelCategorySelector<D> {\n      return makeModelCategorySelector(client, model)\n    },\n  }\n\n  return new Proxy(instance, {\n    get(target, prop) {\n      if (typeof prop === 'string' && !Reflect.has(target, prop)) {\n        return makeModelCategoryInstance(client, model, prop)\n      }\n\n      return Reflect.get(target, prop)\n    },\n  }) as ProxiedModelInstance<D>\n}\n\nexport { ProxiedModelInstance }\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/instances/Model/index.ts"],"names":[],"mappings":";;;;;AAOA,kEAAwE;AACxE,kFAEsC;AACtC,qEAEyB;AAEzB,SAAwB,iBAAiB,CACvC,MAAuB,EACvB,KAAa;IAEb,MAAM,QAAQ,GAAG;QACf,GAAG;YACD,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,EAAE,CAAC,CAAA;QACvC,CAAC;QAED,QAAQ,CAAC,IAAY;YACnB,OAAO,IAAA,uBAAyB,EAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;QACvD,CAAC;QAED,IAAI,OAAO;YACT,OAAO,IAAA,eAAiB,EAAI,MAAM,EAAE,KAAK,CAAC,CAAA;QAC5C,CAAC;QAED,IAAI,UAAU;YACZ,OAAO,IAAA,uBAAyB,EAAC,MAAM,EAAE,KAAK,CAAC,CAAA;QACjD,CAAC;KACF,CAAA;IAED,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE;QACzB,GAAG,CAAC,MAAM,EAAE,IAAI;YACd,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;gBAC1D,OAAO,IAAA,uBAAyB,EAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;aACtD;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAA4B,CAAA;AAC/B,CAAC;AA/BD,oCA+BC","sourcesContent":["import {\n  Model,\n  SerializedData,\n  StarlightClient,\n  StarlightItemResponse,\n} from '../../types'\nimport { DynamicModelInstance, ModelInstance } from './types'\nimport makeEntrySelector, { EntrySelector } from '../../selectors/Entry'\nimport makeModelCategorySelector, {\n  DynamicModelCategorySelector,\n} from '../../selectors/ModelCategory'\nimport makeModelCategoryInstance, {\n  ModelCategoryInstance,\n} from '../ModelCategory'\n\nexport default function makeModelInstance<D extends SerializedData>(\n  client: StarlightClient,\n  model: string\n): DynamicModelInstance<D> {\n  const instance = {\n    get(): Promise<StarlightItemResponse<Model>> {\n      return client.get(`/models/${model}`)\n    },\n\n    category(slug: string): ModelCategoryInstance<D> {\n      return makeModelCategoryInstance(client, model, slug)\n    },\n\n    get entries(): EntrySelector<D> {\n      return makeEntrySelector<D>(client, model)\n    },\n\n    get categories(): DynamicModelCategorySelector<D> {\n      return makeModelCategorySelector(client, model)\n    },\n  }\n\n  return new Proxy(instance, {\n    get(target, prop) {\n      if (typeof prop === 'string' && !Reflect.has(target, prop)) {\n        return makeModelCategoryInstance(client, model, prop)\n      }\n\n      return Reflect.get(target, prop)\n    },\n  }) as DynamicModelInstance<D>\n}\n\nexport { DynamicModelInstance, ModelInstance }\n"]}

package/dist/cjs/instances/Model/types.d.ts

@@ -1,14 +1,97 @@
 import { Model, SerializedData, StarlightItemResponse } from '../../types';
 import { EntrySelector } from '../../selectors/Entry';
-import { ProxiedModelCategorySelector } from '../../selectors/ModelCategory';
+import { DynamicModelCategorySelector } from '../../selectors/ModelCategory';
 import { ModelCategoryInstance } from '../ModelCategory';
+/**
+ * An Instance that provide methods to request information from a {@link Model},
+ * its {@apilink Entry | Entries}, and its {@apilink ModelCategory | Categories}.
+ *
+ * You can access a ModelInstance using {@apilink StarlightClient.model} or
+ * using the dynamic syntax on a {@link DynamicStarlightClient}. Usage
+ * examples will use the dynamic syntax.
+ *
+ * To list all workspace models, use a {@link ModelSelector}.
+ *
+ * @group Instances
+ */
 export interface ModelInstance<D extends SerializedData> {
+    /**
+     * Returns a {@link StarlightItemResponse} with a single {@link Model}.
+     *
+     * @example Requesting information from a model of slug `posts`.
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.posts.get()
+     * ```
+     */
     get(): Promise<StarlightItemResponse<Model>>;
+    /**
+     * Returns a {@link ModelCategoryInstance}.
+     *
+     * If you're using a {@link DynamicModelInstance}, you can use the
+     * dynamic syntax instead of this method.
+     *
+     * @example Listing all entries from the "news" category of a model of slug "posts".
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.posts.category('news').entries()
+     * ```
+     *
+     * @param slug The category slug.
+     */
     category(slug: string): ModelCategoryInstance<D>;
+    /**
+     * Returns an {@link EntrySelector}.
+     *
+     * This is an accessor, which means that it should be used just like a common
+     * object parameter. For instance:
+     *
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * // "entries" below is an EntrySelector.
+     * const response = await Starlight.posts.entries.list()
+     * ```
+     */
     get entries(): EntrySelector<D>;
-    get categories(): ProxiedModelCategorySelector<D>;
+    /**
+     * Returns a {@link DynamicModelCategorySelector}.
+     *
+     * This is an accessor, which means that it should be used just like a common
+     * object parameter. For instance:
+     *
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * // "categories" below is a DynamicModelCategorySelector.
+     * const response = await Starlight.posts.categories.get('interviews')
+     * ```
+     */
+    get categories(): DynamicModelCategorySelector<D>;
 }
-export declare type ProxiedModelInstance<D extends SerializedData> = ModelInstance<D> & {
+/**
+ * An Instance that provide all {@link ModelInstance} methods and adds support
+ * for creating {@apilink ModelCategoryInstance | ModelCategoryInstances} using
+ * the dynamic syntax.
+ *
+ * See {@link ModelInstance} to view all available methods.
+ *
+ * See {@doclink requests-and-responses#dynamic-syntax | Dynamic Instances}
+ * documentation to learn more about the dynamic syntax.
+ *
+ * @example Accessing a ModelCategoryInstance using the dynamic syntax.
+ * ```ts
+ * import Starlight from '@starlightcms/js-sdk'
+ *
+ * // "articles" below will be a ModelCategoryInstance.
+ * const response = await Starlight.posts.articles.list()
+ * ```
+ *
+ * @category Instances
+ */
+export declare type DynamicModelInstance<D extends SerializedData> = ModelInstance<D> & {
     [key: string]: ModelCategoryInstance<D>;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/cjs/instances/Model/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/instances/Model/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAC1E,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,4BAA4B,EAAE,MAAM,+BAA+B,CAAA;AAC5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAA;AAExD,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,cAAc;IACrD,GAAG,IAAI,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAA;IAC5C,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAA;IAChD,IAAI,OAAO,IAAI,aAAa,CAAC,CAAC,CAAC,CAAA;IAC/B,IAAI,UAAU,IAAI,4BAA4B,CAAC,CAAC,CAAC,CAAA;CAClD;AAED,oBAAY,oBAAoB,CAAC,CAAC,SAAS,cAAc,IACvD,aAAa,CAAC,CAAC,CAAC,GAAG;IACjB,CAAC,GAAG,EAAE,MAAM,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAA;CACxC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/instances/Model/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAC1E,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,4BAA4B,EAAE,MAAM,+BAA+B,CAAA;AAC5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAA;AAExD;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,cAAc;IACrD;;;;;;;;;OASG;IACH,GAAG,IAAI,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAA;IAE5C;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAA;IAEhD;;;;;;;;;;;;OAYG;IACH,IAAI,OAAO,IAAI,aAAa,CAAC,CAAC,CAAC,CAAA;IAE/B;;;;;;;;;;;;OAYG;IACH,IAAI,UAAU,IAAI,4BAA4B,CAAC,CAAC,CAAC,CAAA;CAClD;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,oBAAY,oBAAoB,CAAC,CAAC,SAAS,cAAc,IACvD,aAAa,CAAC,CAAC,CAAC,GAAG;IACjB,CAAC,GAAG,EAAE,MAAM,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAA;CACxC,CAAA"}

package/dist/cjs/instances/Model/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/instances/Model/types.ts"],"names":[],"mappings":"","sourcesContent":["import { Model, SerializedData, StarlightItemResponse } from '../../types'\nimport { EntrySelector } from '../../selectors/Entry'\nimport { ProxiedModelCategorySelector } from '../../selectors/ModelCategory'\nimport { ModelCategoryInstance } from '../ModelCategory'\n\nexport interface ModelInstance<D extends SerializedData> {\n  get(): Promise<StarlightItemResponse<Model>>\n  category(slug: string): ModelCategoryInstance<D>\n  get entries(): EntrySelector<D>\n  get categories(): ProxiedModelCategorySelector<D>\n}\n\nexport type ProxiedModelInstance<D extends SerializedData> =\n  ModelInstance<D> & {\n    [key: string]: ModelCategoryInstance<D>\n  }\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/instances/Model/types.ts"],"names":[],"mappings":"","sourcesContent":["import { Model, SerializedData, StarlightItemResponse } from '../../types'\nimport { EntrySelector } from '../../selectors/Entry'\nimport { DynamicModelCategorySelector } from '../../selectors/ModelCategory'\nimport { ModelCategoryInstance } from '../ModelCategory'\n\n/**\n * An Instance that provide methods to request information from a {@link Model},\n * its {@apilink Entry | Entries}, and its {@apilink ModelCategory | Categories}.\n *\n * You can access a ModelInstance using {@apilink StarlightClient.model} or\n * using the dynamic syntax on a {@link DynamicStarlightClient}. Usage\n * examples will use the dynamic syntax.\n *\n * To list all workspace models, use a {@link ModelSelector}.\n *\n * @group Instances\n */\nexport interface ModelInstance<D extends SerializedData> {\n  /**\n   * Returns a {@link StarlightItemResponse} with a single {@link Model}.\n   *\n   * @example Requesting information from a model of slug `posts`.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.posts.get()\n   * ```\n   */\n  get(): Promise<StarlightItemResponse<Model>>\n\n  /**\n   * Returns a {@link ModelCategoryInstance}.\n   *\n   * If you're using a {@link DynamicModelInstance}, you can use the\n   * dynamic syntax instead of this method.\n   *\n   * @example Listing all entries from the \"news\" category of a model of slug \"posts\".\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.posts.category('news').entries()\n   * ```\n   *\n   * @param slug The category slug.\n   */\n  category(slug: string): ModelCategoryInstance<D>\n\n  /**\n   * Returns an {@link EntrySelector}.\n   *\n   * This is an accessor, which means that it should be used just like a common\n   * object parameter. For instance:\n   *\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * // \"entries\" below is an EntrySelector.\n   * const response = await Starlight.posts.entries.list()\n   * ```\n   */\n  get entries(): EntrySelector<D>\n\n  /**\n   * Returns a {@link DynamicModelCategorySelector}.\n   *\n   * This is an accessor, which means that it should be used just like a common\n   * object parameter. For instance:\n   *\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * // \"categories\" below is a DynamicModelCategorySelector.\n   * const response = await Starlight.posts.categories.get('interviews')\n   * ```\n   */\n  get categories(): DynamicModelCategorySelector<D>\n}\n\n/**\n * An Instance that provide all {@link ModelInstance} methods and adds support\n * for creating {@apilink ModelCategoryInstance | ModelCategoryInstances} using\n * the dynamic syntax.\n *\n * See {@link ModelInstance} to view all available methods.\n *\n * See {@doclink requests-and-responses#dynamic-syntax | Dynamic Instances}\n * documentation to learn more about the dynamic syntax.\n *\n * @example Accessing a ModelCategoryInstance using the dynamic syntax.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * // \"articles\" below will be a ModelCategoryInstance.\n * const response = await Starlight.posts.articles.list()\n * ```\n *\n * @category Instances\n */\nexport type DynamicModelInstance<D extends SerializedData> =\n  ModelInstance<D> & {\n    [key: string]: ModelCategoryInstance<D>\n  }\n"]}