@starlightcms/js-sdk 0.9.0 → 0.11.0

package/dist/esm/selectors/Media/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Media/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  MediaObject,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\n\nexport interface MediaSelector {\n  get(slug: number | string): Promise<StarlightItemResponse<MediaObject>>\n  list(): Promise<StarlightListResponse<MediaObject>>\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Media/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  MediaObject,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\n\n/**\n * A Selector that provide methods to list and request information on\n * {@apilink MediaObject | MediaObjects}.\n *\n * You can use a MediaSelector by accessing\n * {@apilink StarlightClient.media}.\n *\n * @group Selectors\n */\nexport interface MediaSelector {\n  /**\n   * Returns a {@link StarlightItemResponse} with a single {@link MediaObject}.\n   *\n   * Note: MediaObjects are identified by their IDs, since they don't have slugs.\n   *\n   * @example Requesting information from a media object of id \"123456789\".\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.media.get('123456789')\n   * ```\n   *\n   * @param id The media object ID.\n   */\n  get(id: number | string): Promise<StarlightItemResponse<MediaObject>>\n\n  /**\n   * Returns a {@link StarlightListResponse} with the list of\n   * {@apilink MediaObject | MediaObjects} in this workspace.\n   *\n   * @example Requesting all media objects from the workspace.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.media.list()\n   * ```\n   */\n  list(): Promise<StarlightListResponse<MediaObject>>\n}\n"]}

package/dist/esm/selectors/Model/index.d.ts

@@ -1,5 +1,5 @@
 import { StarlightClient, WorkspaceModelDefinition } from '../../types';
-import { ModelSelector, ProxiedModelSelector } from './types';
-export default function makeModelSelector<D extends WorkspaceModelDefinition>(client: StarlightClient): ProxiedModelSelector<D>;
-export { ModelSelector, ProxiedModelSelector };
+import { ModelSelector, DynamicModelSelector } from './types';
+export default function makeModelSelector<D extends WorkspaceModelDefinition>(client: StarlightClient): DynamicModelSelector<D>;
+export { ModelSelector, DynamicModelSelector };
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/selectors/Model/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Model/index.ts"],"names":[],"mappings":"AAQA,OAAO,iBAAiB,MAAM,uBAAuB,CAAA;AAErD,MAAM,CAAC,OAAO,UAAU,iBAAiB,CACvC,MAAuB;IAEvB,MAAM,WAAW,GAAkB;QACjC,IAAI;YACF,OAAO,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;QAC9B,CAAC;QAED,GAAG,CAAC,IAAI;YACN,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC,CAAA;QACtC,CAAC;KACF,CAAA;IAED,OAAO,IAAI,KAAK,CAAC,WAAW,EAAE;QAC5B,GAAG,CAAC,MAAM,EAAE,IAAI;YACd,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;gBAC1D,OAAO,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;aACvC;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAA4B,CAAA;AAC/B,CAAC","sourcesContent":["import {\n  Model,\n  StarlightClient,\n  StarlightItemResponse,\n  StarlightListResponse,\n  WorkspaceModelDefinition,\n} from '../../types'\nimport { ModelSelector, ProxiedModelSelector } from './types'\nimport makeModelInstance from '../../instances/Model'\n\nexport default function makeModelSelector<D extends WorkspaceModelDefinition>(\n  client: StarlightClient\n): ProxiedModelSelector<D> {\n  const modelClient: ModelSelector = {\n    list(): Promise<StarlightListResponse<Model>> {\n      return client.get('/models')\n    },\n\n    get(slug): Promise<StarlightItemResponse<Model>> {\n      return client.get(`/models/${slug}`)\n    },\n  }\n\n  return new Proxy(modelClient, {\n    get(target, prop) {\n      if (typeof prop === 'string' && !Reflect.has(target, prop)) {\n        return makeModelInstance(client, prop)\n      }\n\n      return Reflect.get(target, prop)\n    },\n  }) as ProxiedModelSelector<D>\n}\n\nexport { ModelSelector, ProxiedModelSelector }\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Model/index.ts"],"names":[],"mappings":"AAQA,OAAO,iBAAiB,MAAM,uBAAuB,CAAA;AAErD,MAAM,CAAC,OAAO,UAAU,iBAAiB,CACvC,MAAuB;IAEvB,MAAM,WAAW,GAAkB;QACjC,IAAI;YACF,OAAO,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;QAC9B,CAAC;QAED,GAAG,CAAC,IAAI;YACN,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC,CAAA;QACtC,CAAC;KACF,CAAA;IAED,OAAO,IAAI,KAAK,CAAC,WAAW,EAAE;QAC5B,GAAG,CAAC,MAAM,EAAE,IAAI;YACd,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;gBAC1D,OAAO,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;aACvC;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAA4B,CAAA;AAC/B,CAAC","sourcesContent":["import {\n  Model,\n  StarlightClient,\n  StarlightItemResponse,\n  StarlightListResponse,\n  WorkspaceModelDefinition,\n} from '../../types'\nimport { ModelSelector, DynamicModelSelector } from './types'\nimport makeModelInstance from '../../instances/Model'\n\nexport default function makeModelSelector<D extends WorkspaceModelDefinition>(\n  client: StarlightClient\n): DynamicModelSelector<D> {\n  const modelClient: ModelSelector = {\n    list(): Promise<StarlightListResponse<Model>> {\n      return client.get('/models')\n    },\n\n    get(slug): Promise<StarlightItemResponse<Model>> {\n      return client.get(`/models/${slug}`)\n    },\n  }\n\n  return new Proxy(modelClient, {\n    get(target, prop) {\n      if (typeof prop === 'string' && !Reflect.has(target, prop)) {\n        return makeModelInstance(client, prop)\n      }\n\n      return Reflect.get(target, prop)\n    },\n  }) as DynamicModelSelector<D>\n}\n\nexport { ModelSelector, DynamicModelSelector }\n"]}

package/dist/esm/selectors/Model/types.d.ts

@@ -1,10 +1,69 @@
 import { Model, StarlightItemResponse, StarlightListResponse, WorkspaceModelDefinition } from '../../types';
-import { ProxiedModelInstance } from '../../instances/Model';
+import { DynamicModelInstance } from '../../instances/Model';
+/**
+ * A Selector that provide methods to list and request information on
+ * {@apilink Model | Models}.
+ *
+ * You can use a ModelSelector by accessing
+ * {@apilink StarlightClient.models}.
+ *
+ * To list entries or categories of a specific model, use a
+ * {@link ModelInstance}.
+ *
+ * @group Selectors
+ */
 export interface ModelSelector {
+    /**
+     * Returns a {@link StarlightListResponse} with a list of
+     * {@apilink Model | Models}.
+     *
+     * @example Requesting all models from a workspace.
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.models.list()
+     * ```
+     */
     list(): Promise<StarlightListResponse<Model>>;
+    /**
+     * Returns a {@link StarlightItemResponse} with a single {@link Model}.
+     *
+     * Note that this method only returns information on a model, like its title,
+     * slug, creation date, and entry count. If you want list its entries or
+     * categories, you need to use a {@link ModelInstance}.
+     *
+     * @example Requesting information from a model of slug "clients".
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.posts.entries.get('clients')
+     * ```
+     *
+     * @param slug The model slug.
+     */
     get(slug: string): Promise<StarlightItemResponse<Model>>;
 }
-export declare type ProxiedModelSelector<T extends WorkspaceModelDefinition> = ModelSelector & {
-    [K in keyof T]: ProxiedModelInstance<T[K]>;
+/**
+ * A Selector that provide all {@link ModelSelector} methods and adds support
+ * for creating {@apilink DynamicModelInstance | DynamicModelInstances} using
+ * the dynamic syntax.
+ *
+ * See {@link ModelSelector} 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 DynamicModelInstance using the dynamic syntax.
+ * ```ts
+ * import Starlight from '@starlightcms/js-sdk'
+ *
+ * // "posts" below will be a DynamicModelInstance.
+ * const response = await Starlight.models.posts.entries.list()
+ * ```
+ *
+ * @category Selectors
+ */
+export declare type DynamicModelSelector<T extends WorkspaceModelDefinition> = ModelSelector & {
+    [K in keyof T]: DynamicModelInstance<T[K]>;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/esm/selectors/Model/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Model/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EACL,qBAAqB,EACrB,qBAAqB,EACrB,wBAAwB,EACzB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAA;AAE5D,MAAM,WAAW,aAAa;IAC5B,IAAI,IAAI,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAA;IAC7C,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAA;CACzD;AAED,oBAAY,oBAAoB,CAAC,CAAC,SAAS,wBAAwB,IACjE,aAAa,GAAG;KACb,CAAC,IAAI,MAAM,CAAC,GAAG,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3C,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Model/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EACL,qBAAqB,EACrB,qBAAqB,EACrB,wBAAwB,EACzB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAA;AAE5D;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;;;;OAUG;IACH,IAAI,IAAI,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAA;IAE7C;;;;;;;;;;;;;;;OAeG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAA;CACzD;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,oBAAY,oBAAoB,CAAC,CAAC,SAAS,wBAAwB,IACjE,aAAa,GAAG;KACb,CAAC,IAAI,MAAM,CAAC,GAAG,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3C,CAAA"}

package/dist/esm/selectors/Model/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Model/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  Model,\n  StarlightItemResponse,\n  StarlightListResponse,\n  WorkspaceModelDefinition,\n} from '../../types'\nimport { ProxiedModelInstance } from '../../instances/Model'\n\nexport interface ModelSelector {\n  list(): Promise<StarlightListResponse<Model>>\n  get(slug: string): Promise<StarlightItemResponse<Model>>\n}\n\nexport type ProxiedModelSelector<T extends WorkspaceModelDefinition> =\n  ModelSelector & {\n    [K in keyof T]: ProxiedModelInstance<T[K]>\n  }\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Model/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  Model,\n  StarlightItemResponse,\n  StarlightListResponse,\n  WorkspaceModelDefinition,\n} from '../../types'\nimport { DynamicModelInstance } from '../../instances/Model'\n\n/**\n * A Selector that provide methods to list and request information on\n * {@apilink Model | Models}.\n *\n * You can use a ModelSelector by accessing\n * {@apilink StarlightClient.models}.\n *\n * To list entries or categories of a specific model, use a\n * {@link ModelInstance}.\n *\n * @group Selectors\n */\nexport interface ModelSelector {\n  /**\n   * Returns a {@link StarlightListResponse} with a list of\n   * {@apilink Model | Models}.\n   *\n   * @example Requesting all models from a workspace.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.models.list()\n   * ```\n   */\n  list(): Promise<StarlightListResponse<Model>>\n\n  /**\n   * Returns a {@link StarlightItemResponse} with a single {@link Model}.\n   *\n   * Note that this method only returns information on a model, like its title,\n   * slug, creation date, and entry count. If you want list its entries or\n   * categories, you need to use a {@link ModelInstance}.\n   *\n   * @example Requesting information from a model of slug \"clients\".\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.posts.entries.get('clients')\n   * ```\n   *\n   * @param slug The model slug.\n   */\n  get(slug: string): Promise<StarlightItemResponse<Model>>\n}\n\n/**\n * A Selector that provide all {@link ModelSelector} methods and adds support\n * for creating {@apilink DynamicModelInstance | DynamicModelInstances} using\n * the dynamic syntax.\n *\n * See {@link ModelSelector} 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 DynamicModelInstance using the dynamic syntax.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * // \"posts\" below will be a DynamicModelInstance.\n * const response = await Starlight.models.posts.entries.list()\n * ```\n *\n * @category Selectors\n */\nexport type DynamicModelSelector<T extends WorkspaceModelDefinition> =\n  ModelSelector & {\n    [K in keyof T]: DynamicModelInstance<T[K]>\n  }\n"]}

package/dist/esm/selectors/ModelCategory/index.d.ts

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

package/dist/esm/selectors/ModelCategory/index.js

@@ -2,7 +2,7 @@ import makeModelCategoryInstance from '../../instances/ModelCategory';
 export default function makeModelCategorySelector(client, model) {
     const selector = {
         list(options) {
-            return client.get(`/models/${model}/categories`, options);
+            return client.get(`/models/${model}/categories`, Object.assign({}, options));
         },
         get(slug) {
             return client.get(`/models/${model}/categories/${slug}`);

package/dist/esm/selectors/ModelCategory/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/ModelCategory/index.ts"],"names":[],"mappings":"AAQA,OAAO,yBAAyB,MAAM,+BAA+B,CAAA;AAErE,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAC/C,MAAuB,EACvB,KAAa;IAEb,MAAM,QAAQ,GAA0B;QACtC,IAAI,CAAC,OAAO;YACV,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,aAAa,EAAE,OAAO,CAAC,CAAA;QAC3D,CAAC;QAED,GAAG,CAAC,IAAI;YACN,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,eAAe,IAAI,EAAE,CAAC,CAAA;QAC1D,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,yBAAyB,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;aACtD;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAAoC,CAAA;AACvC,CAAC","sourcesContent":["import {\n  ModelCategory,\n  SerializedData,\n  StarlightClient,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\nimport { ModelCategorySelector, ProxiedModelCategorySelector } from './types'\nimport makeModelCategoryInstance from '../../instances/ModelCategory'\n\nexport default function makeModelCategorySelector<D extends SerializedData>(\n  client: StarlightClient,\n  model: string\n): ProxiedModelCategorySelector<D> {\n  const selector: ModelCategorySelector = {\n    list(options): Promise<StarlightListResponse<ModelCategory>> {\n      return client.get(`/models/${model}/categories`, options)\n    },\n\n    get(slug): Promise<StarlightItemResponse<ModelCategory>> {\n      return client.get(`/models/${model}/categories/${slug}`)\n    },\n  }\n\n  return new Proxy(selector, {\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 ProxiedModelCategorySelector<D>\n}\n\nexport { ModelCategorySelector, ProxiedModelCategorySelector }\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/ModelCategory/index.ts"],"names":[],"mappings":"AAQA,OAAO,yBAAyB,MAAM,+BAA+B,CAAA;AAErE,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAC/C,MAAuB,EACvB,KAAa;IAEb,MAAM,QAAQ,GAA0B;QACtC,IAAI,CAAC,OAAO;YACV,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,aAAa,oBAAO,OAAO,EAAG,CAAA;QAClE,CAAC;QAED,GAAG,CAAC,IAAI;YACN,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,eAAe,IAAI,EAAE,CAAC,CAAA;QAC1D,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,yBAAyB,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;aACtD;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAAoC,CAAA;AACvC,CAAC","sourcesContent":["import {\n  ModelCategory,\n  SerializedData,\n  StarlightClient,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\nimport { ModelCategorySelector, DynamicModelCategorySelector } from './types'\nimport makeModelCategoryInstance from '../../instances/ModelCategory'\n\nexport default function makeModelCategorySelector<D extends SerializedData>(\n  client: StarlightClient,\n  model: string\n): DynamicModelCategorySelector<D> {\n  const selector: ModelCategorySelector = {\n    list(options): Promise<StarlightListResponse<ModelCategory>> {\n      return client.get(`/models/${model}/categories`, { ...options })\n    },\n\n    get(slug): Promise<StarlightItemResponse<ModelCategory>> {\n      return client.get(`/models/${model}/categories/${slug}`)\n    },\n  }\n\n  return new Proxy(selector, {\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 DynamicModelCategorySelector<D>\n}\n\nexport { ModelCategorySelector, DynamicModelCategorySelector }\n"]}

package/dist/esm/selectors/ModelCategory/types.d.ts

@@ -1,16 +1,59 @@
-import { ModelCategory, SerializedData, StarlightItemResponse, StarlightListResponse } from '../../types';
+import { BaseRequestParameters, ModelCategory, SerializedData, StarlightItemResponse, StarlightListResponse } from '../../types';
 import { ModelCategoryInstance } from '../../instances/ModelCategory';
-export declare type ListModelCategoriesOptions = {
-    query?: string;
-    page?: number;
-    limit?: number;
+export interface ListModelCategoriesOptions extends BaseRequestParameters {
+    /**
+     * Define how items will be ordered. Check this field type to see the
+     * allowed options.
+     */
     order?: 'title:asc' | 'title:desc' | 'entry_count:asc' | 'entry_count:desc';
-};
+}
+/**
+ * A Selector that provide methods to list and request information on
+ * {@apilink ModelCategory | ModelCategories}.
+ *
+ * You can use a ModelCategorySelector by accessing
+ * {@apilink ModelInstance.categories}.
+ *
+ * @group Selectors
+ */
 export interface ModelCategorySelector {
     list(options?: ListModelCategoriesOptions): Promise<StarlightListResponse<ModelCategory>>;
+    /**
+     * Returns a {@link StarlightItemResponse} with a single {@link ModelCategory}.
+     *
+     * @example Requesting information from a category "premium" from a model of slug "plans".
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.plans.premium.get()
+     * ```
+     *
+     * @param slug The category slug.
+     */
     get(slug: string): Promise<StarlightItemResponse<ModelCategory>>;
 }
-export declare type ProxiedModelCategorySelector<D extends SerializedData> = ModelCategorySelector & {
+/**
+ * A Selector that provide all {@link ModelCategorySelector} methods and adds
+ * support for creating {@apilink ModelCategoryInstance | ModelCategoryInstances}
+ * using the dynamic syntax.
+ *
+ * See {@link ModelCategorySelector} to view all available methods. You can use
+ * a DynamicModelCategorySelector by accessing {@apilink ModelInstance.categories}.
+ *
+ * See {@doclink requests-and-responses#dynamic-syntax | Dynamic Instances}
+ * documentation to learn more about the dynamic syntax.
+ *
+ * @example Accessing a ModelCategorySelector using the dynamic syntax on a model of slug "posts"
+ * ```ts
+ * import Starlight from '@starlightcms/js-sdk'
+ *
+ * // "articles" below will be a ModelCategorySelector.
+ * const response = await Starlight.posts.categories.articles.list()
+ * ```
+ *
+ * @category Instances
+ */
+export declare type DynamicModelCategorySelector<D extends SerializedData> = ModelCategorySelector & {
     [slug: string]: ModelCategoryInstance<D>;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/esm/selectors/ModelCategory/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/ModelCategory/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAA;AAErE,oBAAY,0BAA0B,GAAG;IACvC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,WAAW,GAAG,YAAY,GAAG,iBAAiB,GAAG,kBAAkB,CAAA;CAC5E,CAAA;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,CACF,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC,CAAA;IAChD,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC,CAAA;CACjE;AAED,oBAAY,4BAA4B,CAAC,CAAC,SAAS,cAAc,IAC/D,qBAAqB,GAAG;IACtB,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAA;CACzC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/ModelCategory/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,aAAa,EACb,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAA;AAErE,MAAM,WAAW,0BAA2B,SAAQ,qBAAqB;IACvE;;;OAGG;IACH,KAAK,CAAC,EAAE,WAAW,GAAG,YAAY,GAAG,iBAAiB,GAAG,kBAAkB,CAAA;CAC5E;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,CACF,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC,CAAA;IAEhD;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC,CAAA;CACjE;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,oBAAY,4BAA4B,CAAC,CAAC,SAAS,cAAc,IAC/D,qBAAqB,GAAG;IACtB,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAA;CACzC,CAAA"}

package/dist/esm/selectors/ModelCategory/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/ModelCategory/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  ModelCategory,\n  SerializedData,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\nimport { ModelCategoryInstance } from '../../instances/ModelCategory'\n\nexport type ListModelCategoriesOptions = {\n  query?: string\n  page?: number\n  limit?: number\n  order?: 'title:asc' | 'title:desc' | 'entry_count:asc' | 'entry_count:desc'\n}\n\nexport interface ModelCategorySelector {\n  list(\n    options?: ListModelCategoriesOptions\n  ): Promise<StarlightListResponse<ModelCategory>>\n  get(slug: string): Promise<StarlightItemResponse<ModelCategory>>\n}\n\nexport type ProxiedModelCategorySelector<D extends SerializedData> =\n  ModelCategorySelector & {\n    [slug: string]: ModelCategoryInstance<D>\n  }\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/ModelCategory/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  BaseRequestParameters,\n  ModelCategory,\n  SerializedData,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\nimport { ModelCategoryInstance } from '../../instances/ModelCategory'\n\nexport interface ListModelCategoriesOptions extends BaseRequestParameters {\n  /**\n   * Define how items will be ordered. Check this field type to see the\n   * allowed options.\n   */\n  order?: 'title:asc' | 'title:desc' | 'entry_count:asc' | 'entry_count:desc'\n}\n\n/**\n * A Selector that provide methods to list and request information on\n * {@apilink ModelCategory | ModelCategories}.\n *\n * You can use a ModelCategorySelector by accessing\n * {@apilink ModelInstance.categories}.\n *\n * @group Selectors\n */\nexport interface ModelCategorySelector {\n  list(\n    options?: ListModelCategoriesOptions\n  ): Promise<StarlightListResponse<ModelCategory>>\n\n  /**\n   * Returns a {@link StarlightItemResponse} with a single {@link ModelCategory}.\n   *\n   * @example Requesting information from a category \"premium\" from a model of slug \"plans\".\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.plans.premium.get()\n   * ```\n   *\n   * @param slug The category slug.\n   */\n  get(slug: string): Promise<StarlightItemResponse<ModelCategory>>\n}\n\n/**\n * A Selector that provide all {@link ModelCategorySelector} methods and adds\n * support for creating {@apilink ModelCategoryInstance | ModelCategoryInstances}\n * using the dynamic syntax.\n *\n * See {@link ModelCategorySelector} to view all available methods. You can use\n * a DynamicModelCategorySelector by accessing {@apilink ModelInstance.categories}.\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 ModelCategorySelector using the dynamic syntax on a model of slug \"posts\"\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * // \"articles\" below will be a ModelCategorySelector.\n * const response = await Starlight.posts.categories.articles.list()\n * ```\n *\n * @category Instances\n */\nexport type DynamicModelCategorySelector<D extends SerializedData> =\n  ModelCategorySelector & {\n    [slug: string]: ModelCategoryInstance<D>\n  }\n"]}

package/dist/esm/selectors/Search/index.d.ts

@@ -1,5 +1,5 @@
 import { StarlightClient } from '../../types';
-import { SearchSelector } from './types';
+import { SearchEntriesParams, SearchSelector } from './types';
 export default function makeSearchSelector(client: StarlightClient): SearchSelector;
-export { SearchSelector };
+export { SearchSelector, SearchEntriesParams };
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/selectors/Search/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Search/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,eAAe,EAEhB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAwB,cAAc,EAAE,MAAM,SAAS,CAAA;AAE9D,MAAM,CAAC,OAAO,UAAU,kBAAkB,CACxC,MAAM,EAAE,eAAe,GACtB,cAAc,CAQhB;AAED,OAAO,EAAE,cAAc,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Search/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,eAAe,EAEhB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAE7D,MAAM,CAAC,OAAO,UAAU,kBAAkB,CACxC,MAAM,EAAE,eAAe,GACtB,cAAc,CAQhB;AAED,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,CAAA"}

package/dist/esm/selectors/Search/index.js

@@ -1,7 +1,7 @@
 export default function makeSearchSelector(client) {
     return {
         entries(options) {
-            return client.get('/search/entries', options);
+            return client.get('/search/entries', Object.assign({}, options));
         },
     };
 }

package/dist/esm/selectors/Search/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Search/index.ts"],"names":[],"mappings":"AAQA,MAAM,CAAC,OAAO,UAAU,kBAAkB,CACxC,MAAuB;IAEvB,OAAO;QACL,OAAO,CACL,OAA6B;YAE7B,OAAO,MAAM,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAA;QAC/C,CAAC;KACF,CAAA;AACH,CAAC","sourcesContent":["import {\n  Entry,\n  SerializedData,\n  StarlightClient,\n  StarlightListResponse,\n} from '../../types'\nimport { SearchEntriesOptions, SearchSelector } from './types'\n\nexport default function makeSearchSelector(\n  client: StarlightClient\n): SearchSelector {\n  return {\n    entries<T extends SerializedData = Record<string, unknown>>(\n      options: SearchEntriesOptions\n    ): Promise<StarlightListResponse<Entry<T>>> {\n      return client.get('/search/entries', options)\n    },\n  }\n}\n\nexport { SearchSelector }\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Search/index.ts"],"names":[],"mappings":"AAQA,MAAM,CAAC,OAAO,UAAU,kBAAkB,CACxC,MAAuB;IAEvB,OAAO;QACL,OAAO,CACL,OAA4B;YAE5B,OAAO,MAAM,CAAC,GAAG,CAAC,iBAAiB,oBAAO,OAAO,EAAG,CAAA;QACtD,CAAC;KACF,CAAA;AACH,CAAC","sourcesContent":["import {\n  Entry,\n  SerializedData,\n  StarlightClient,\n  StarlightListResponse,\n} from '../../types'\nimport { SearchEntriesParams, SearchSelector } from './types'\n\nexport default function makeSearchSelector(\n  client: StarlightClient\n): SearchSelector {\n  return {\n    entries<T extends SerializedData = Record<string, unknown>>(\n      options: SearchEntriesParams\n    ): Promise<StarlightListResponse<Entry<T>>> {\n      return client.get('/search/entries', { ...options })\n    },\n  }\n}\n\nexport { SearchSelector, SearchEntriesParams }\n"]}

package/dist/esm/selectors/Search/types.d.ts

@@ -1,14 +1,87 @@
-import { Entry, SerializedData, StarlightListResponse } from '../../types';
-export declare type SearchEntriesOptions = {
-    page?: number;
-    limit?: number;
-    query?: string;
+import { BaseRequestParameters, Entry, SerializedData, StarlightListResponse } from '../../types';
+/**
+ * Request parameters for searching entries.
+ *
+ * Used by {@apilink SearchSelector.entries}.
+ *
+ * @group Request Parameters
+ */
+export interface SearchEntriesParams extends BaseRequestParameters {
+    /**
+     * A comma-separated list of models. Only entries in these models
+     * will be returned. If undefined, entries from all
+     * workspace models will be listed.
+     *
+     * For instance, to show only entries in the "posts" and "videos" categories,
+     * pass `'posts,videos'`.
+     */
     models?: string;
+    /**
+     * A comma-separated list of categories. Only entries in these categories
+     * will be returned. If undefined, all entries will be listed, independently
+     * of their categories.
+     *
+     * For instance, to show only entries in the "news" and "articles" categories,
+     * pass `'news,category'`.
+     */
     categories?: string;
+    /**
+     * Define how items will be ordered. Check this field type to see the
+     * allowed options.
+     */
     order?: 'title:asc' | 'title:desc' | 'published_at:asc' | 'published_at:desc' | 'updated_at:asc' | 'updated_at:desc';
+    /**
+     * If defined, removes the given item from the list. Useful to create "related
+     * posts" lists.
+     *
+     * Note: this field only accepts IDs, and not slugs. Only one ID is allowed.
+     */
     except?: number;
-};
+}
+/**
+ * A Selector that provide methods to search for content. Only entry search
+ * is supported for the time being.
+ *
+ * You can use a SearchSelector by accessing
+ * {@apilink StarlightClient.search}.
+ *
+ * @group Selectors
+ */
 export interface SearchSelector {
-    entries<T extends SerializedData = Record<string, unknown>>(options?: SearchEntriesOptions): Promise<StarlightListResponse<Entry<T>>>;
+    /**
+     * Returns a {@link StarlightListResponse} with a list of
+     * {@apilink Entry | Entries}. By default, entries from all models are
+     * returned, but filtering by model can be configured.
+     *
+     * @example Listing all entries in all workspace models.
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.search.entries()
+     * ```
+     *
+     * @example Searching for "hello world" within all entries in all workspace models.
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.search.entries({
+     *   query: 'hello world'
+     * })
+     * ```
+     *
+     * @example Filtering the last example within specific models.
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.search.entries({
+     *   query: 'hello world',
+     *   models: 'posts,videos,magazines'
+     * })
+     * ```
+     *
+     * @param options An optional object of request parameters. See
+     * {@link SearchEntriesParams} for all available options.
+     */
+    entries<T extends SerializedData = Record<string, unknown>>(options?: SearchEntriesParams): Promise<StarlightListResponse<Entry<T>>>;
 }
 //# sourceMappingURL=types.d.ts.map

package/dist/esm/selectors/Search/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Search/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAE1E,oBAAY,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EACF,WAAW,GACX,YAAY,GACZ,kBAAkB,GAClB,mBAAmB,GACnB,gBAAgB,GAChB,iBAAiB,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,CAAC,SAAS,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACxD,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;CAC5C"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Search/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,KAAK,EACL,cAAc,EACd,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB;;;;;;GAMG;AACH,MAAM,WAAW,mBAAoB,SAAQ,qBAAqB;IAChE;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,KAAK,CAAC,EACF,WAAW,GACX,YAAY,GACZ,kBAAkB,GAClB,mBAAmB,GACnB,gBAAgB,GAChB,iBAAiB,CAAA;IACrB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,OAAO,CAAC,CAAC,SAAS,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACxD,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;CAC5C"}

package/dist/esm/selectors/Search/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Search/types.ts"],"names":[],"mappings":"","sourcesContent":["import { Entry, SerializedData, StarlightListResponse } from '../../types'\n\nexport type SearchEntriesOptions = {\n  page?: number\n  limit?: number\n  query?: string\n  models?: string\n  categories?: string\n  order?:\n    | 'title:asc'\n    | 'title:desc'\n    | 'published_at:asc'\n    | 'published_at:desc'\n    | 'updated_at:asc'\n    | 'updated_at:desc'\n  except?: number\n}\n\nexport interface SearchSelector {\n  entries<T extends SerializedData = Record<string, unknown>>(\n    options?: SearchEntriesOptions\n  ): Promise<StarlightListResponse<Entry<T>>>\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Search/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  BaseRequestParameters,\n  Entry,\n  SerializedData,\n  StarlightListResponse,\n} from '../../types'\n\n/**\n * Request parameters for searching entries.\n *\n * Used by {@apilink SearchSelector.entries}.\n *\n * @group Request Parameters\n */\nexport interface SearchEntriesParams extends BaseRequestParameters {\n  /**\n   * A comma-separated list of models. Only entries in these models\n   * will be returned. If undefined, entries from all\n   * workspace models will be listed.\n   *\n   * For instance, to show only entries in the \"posts\" and \"videos\" categories,\n   * pass `'posts,videos'`.\n   */\n  models?: string\n  /**\n   * A comma-separated list of categories. Only entries in these categories\n   * will be returned. If undefined, all entries will be listed, independently\n   * of their categories.\n   *\n   * For instance, to show only entries in the \"news\" and \"articles\" categories,\n   * pass `'news,category'`.\n   */\n  categories?: string\n  /**\n   * Define how items 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    | 'updated_at:asc'\n    | 'updated_at:desc'\n  /**\n   * If defined, removes the given item from the list. Useful to create \"related\n   * posts\" lists.\n   *\n   * Note: this field only accepts IDs, and not slugs. Only one ID is allowed.\n   */\n  except?: number\n}\n\n/**\n * A Selector that provide methods to search for content. Only entry search\n * is supported for the time being.\n *\n * You can use a SearchSelector by accessing\n * {@apilink StarlightClient.search}.\n *\n * @group Selectors\n */\nexport interface SearchSelector {\n  /**\n   * Returns a {@link StarlightListResponse} with a list of\n   * {@apilink Entry | Entries}. By default, entries from all models are\n   * returned, but filtering by model can be configured.\n   *\n   * @example Listing all entries in all workspace models.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.search.entries()\n   * ```\n   *\n   * @example Searching for \"hello world\" within all entries in all workspace models.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.search.entries({\n   *   query: 'hello world'\n   * })\n   * ```\n   *\n   * @example Filtering the last example within specific models.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.search.entries({\n   *   query: 'hello world',\n   *   models: 'posts,videos,magazines'\n   * })\n   * ```\n   *\n   * @param options An optional object of request parameters. See\n   * {@link SearchEntriesParams} for all available options.\n   */\n  entries<T extends SerializedData = Record<string, unknown>>(\n    options?: SearchEntriesParams\n  ): Promise<StarlightListResponse<Entry<T>>>\n}\n"]}

package/dist/esm/selectors/Singleton/types.d.ts

@@ -1,6 +1,55 @@
 import { SerializedData, Singleton, StarlightItemResponse, StarlightListResponse } from '../../types';
+/**
+ * A Selector that provide methods to list and request information on
+ * {@apilink Singleton | Singletons}.
+ *
+ * You can use an SingletonSelector by accessing
+ * {@apilink ModelInstance.singletons}.
+ *
+ * @group Selectors
+ */
 export interface SingletonSelector {
+    /**
+     * Returns a {@link StarlightItemResponse} with a single {@link Singleton}.
+     * This methods supports typing the returned Singleton by passing its data
+     * type as the generic type `<D>`.
+     *
+     * @example Requesting information from a singleton of slug "home".
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.singletons.get('home')
+     * ```
+     *
+     * @example Typing last example's response.
+     * ```ts
+     * import Starlight, { StringField, MediaField, VisualField } from '@starlightcms/js-sdk'
+     *
+     * type HomeFields = {
+     *   title: StringField
+     *   subtitle: StringField
+     *   hero_image: MediaField
+     *   hero_content: VisualField
+     * }
+     *
+     * // `response.data` will be of type Singleton<HomeFields>
+     * const response = await Starlight.singletons.get<HomeFields>('home')
+     * ```
+     * @typeParam D - The type of the returned Singleton's `data` property.
+     * @param slug The singleton slug.
+     */
     get<D extends SerializedData>(slug: string): Promise<StarlightItemResponse<Singleton<D>>>;
+    /**
+     * Returns a {@link StarlightListResponse} with a list of
+     * {@apilink Singleton | Singletons}.
+     *
+     * @example Requesting all workspace singletons.
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.singletons.list()
+     * ```
+     */
     list(): Promise<StarlightListResponse<Singleton<Record<string, unknown>>>>;
 }
 //# sourceMappingURL=types.d.ts.map

package/dist/esm/selectors/Singleton/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Singleton/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,SAAS,EACT,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB,MAAM,WAAW,iBAAiB;IAChC,GAAG,CAAC,CAAC,SAAS,cAAc,EAC1B,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAC/C,IAAI,IAAI,OAAO,CAAC,qBAAqB,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAA;CAC3E"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Singleton/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,SAAS,EACT,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,GAAG,CAAC,CAAC,SAAS,cAAc,EAC1B,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAE/C;;;;;;;;;;OAUG;IACH,IAAI,IAAI,OAAO,CAAC,qBAAqB,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAA;CAC3E"}

package/dist/esm/selectors/Singleton/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Singleton/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  SerializedData,\n  Singleton,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\n\nexport interface SingletonSelector {\n  get<D extends SerializedData>(\n    slug: string\n  ): Promise<StarlightItemResponse<Singleton<D>>>\n  list(): Promise<StarlightListResponse<Singleton<Record<string, unknown>>>>\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Singleton/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  SerializedData,\n  Singleton,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\n\n/**\n * A Selector that provide methods to list and request information on\n * {@apilink Singleton | Singletons}.\n *\n * You can use an SingletonSelector by accessing\n * {@apilink ModelInstance.singletons}.\n *\n * @group Selectors\n */\nexport interface SingletonSelector {\n  /**\n   * Returns a {@link StarlightItemResponse} with a single {@link Singleton}.\n   * This methods supports typing the returned Singleton by passing its data\n   * type as the generic type `<D>`.\n   *\n   * @example Requesting information from a singleton of slug \"home\".\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.singletons.get('home')\n   * ```\n   *\n   * @example Typing last example's response.\n   * ```ts\n   * import Starlight, { StringField, MediaField, VisualField } from '@starlightcms/js-sdk'\n   *\n   * type HomeFields = {\n   *   title: StringField\n   *   subtitle: StringField\n   *   hero_image: MediaField\n   *   hero_content: VisualField\n   * }\n   *\n   * // `response.data` will be of type Singleton<HomeFields>\n   * const response = await Starlight.singletons.get<HomeFields>('home')\n   * ```\n   * @typeParam D - The type of the returned Singleton's `data` property.\n   * @param slug The singleton slug.\n   */\n  get<D extends SerializedData>(\n    slug: string\n  ): Promise<StarlightItemResponse<Singleton<D>>>\n\n  /**\n   * Returns a {@link StarlightListResponse} with a list of\n   * {@apilink Singleton | Singletons}.\n   *\n   * @example Requesting all workspace singletons.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.singletons.list()\n   * ```\n   */\n  list(): Promise<StarlightListResponse<Singleton<Record<string, unknown>>>>\n}\n"]}