@starlightcms/js-sdk 0.9.0 → 0.11.0

package/dist/esm/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/esm/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/esm/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"]}

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

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

package/dist/esm/instances/ModelCategory/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/instances/ModelCategory/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,cAAc,EACd,eAAe,EAGhB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,qBAAqB,EAAiC,MAAM,SAAS,CAAA;AAE9E,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAAC,CAAC,SAAS,cAAc,EACxE,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,GACf,qBAAqB,CAAC,CAAC,CAAC,CAc1B;AAED,OAAO,EAAE,qBAAqB,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/instances/ModelCategory/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,cAAc,EACd,eAAe,EAGhB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,qBAAqB,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAA;AAE7E,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAAC,CAAC,SAAS,cAAc,EACxE,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,GACf,qBAAqB,CAAC,CAAC,CAAC,CAc1B;AAED,OAAO,EAAE,qBAAqB,EAAE,4BAA4B,EAAE,CAAA"}

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/instances/ModelCategory/index.ts"],"names":[],"mappings":"AAUA,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAC/C,MAAuB,EACvB,KAAa,EACb,QAAgB;IAEhB,OAAO;QACL,GAAG;YACD,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,eAAe,QAAQ,EAAE,CAAC,CAAA;QAC9D,CAAC;QACD,OAAO,CACL,OAAyC;YAEzC,OAAO,MAAM,CAAC,GAAG,CACf,WAAW,KAAK,eAAe,QAAQ,UAAU,EACjD,OAAO,CACR,CAAA;QACH,CAAC;KACF,CAAA;AACH,CAAC","sourcesContent":["import {\n  Entry,\n  ModelCategory,\n  SerializedData,\n  StarlightClient,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\nimport { ModelCategoryInstance, ModelCategoryEntryListOptions } from './types'\n\nexport default function makeModelCategoryInstance<D extends SerializedData>(\n  client: StarlightClient,\n  model: string,\n  category: string\n): ModelCategoryInstance<D> {\n  return {\n    get(): Promise<StarlightItemResponse<ModelCategory>> {\n      return client.get(`/models/${model}/categories/${category}`)\n    },\n    entries(\n      options: ModelCategoryEntryListOptions<D>\n    ): Promise<StarlightListResponse<Entry<D>>> {\n      return client.get(\n        `/models/${model}/categories/${category}/entries`,\n        options\n      )\n    },\n  }\n}\n\nexport { ModelCategoryInstance }\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/instances/ModelCategory/index.ts"],"names":[],"mappings":"AAWA,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAC/C,MAAuB,EACvB,KAAa,EACb,QAAgB;IAEhB,OAAO;QACL,GAAG;YACD,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,eAAe,QAAQ,EAAE,CAAC,CAAA;QAC9D,CAAC;QACD,OAAO,CACL,OAA0D;YAE1D,OAAO,MAAM,CAAC,GAAG,CACf,WAAW,KAAK,eAAe,QAAQ,UAAU,EACjD,OAAO,CACR,CAAA;QACH,CAAC;KACF,CAAA;AACH,CAAC","sourcesContent":["import {\n  Entry,\n  ModelCategory,\n  QueryableFields,\n  SerializedData,\n  StarlightClient,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\nimport { ModelCategoryInstance, ModelCategoryEntryListParams } from './types'\n\nexport default function makeModelCategoryInstance<D extends SerializedData>(\n  client: StarlightClient,\n  model: string,\n  category: string\n): ModelCategoryInstance<D> {\n  return {\n    get(): Promise<StarlightItemResponse<ModelCategory>> {\n      return client.get(`/models/${model}/categories/${category}`)\n    },\n    entries(\n      options: ModelCategoryEntryListParams & QueryableFields<D>\n    ): Promise<StarlightListResponse<Entry<D>>> {\n      return client.get(\n        `/models/${model}/categories/${category}/entries`,\n        options\n      )\n    },\n  }\n}\n\nexport { ModelCategoryInstance, ModelCategoryEntryListParams }\n"]}

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

@@ -1,15 +1,67 @@
-import { Entry, ModelCategory, ModelFieldOptions, SerializedData, StarlightItemResponse, StarlightListResponse } from '../../types';
-export declare type ModelCategoryEntryListOptions<D extends SerializedData> = {
-    page?: number;
-    limit?: number;
-    query?: string;
-    'query:word'?: string;
-    fields?: string;
+import { BaseRequestParameters, Entry, ModelCategory, QueryableFields, QueryableRequestParameters, SerializedData, StarlightItemResponse, StarlightListResponse } from '../../types';
+/**
+ * Request parameters for listing category entries.
+ *
+ * Used by {@apilink ModelCategoryInstance.entries}.
+ *
+ * @group Request Parameters
+ */
+export interface ModelCategoryEntryListParams 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;
-} & ModelFieldOptions<D>;
+}
+/**
+ * An Instance that provide methods to request information from a
+ * {@link ModelCategory} and its {@apilink Entry | Entries}.
+ *
+ * You can access a ModelCategoryInstance using
+ * {@apilink ModelInstance.category} or using the dynamic syntax on a
+ * {@link DynamicModelInstance}. Usage examples will use the dynamic syntax.
+ *
+ * To list all categories from a model, use a {@link ModelCategorySelector}.
+ *
+ * @group Instances
+ */
 export interface ModelCategoryInstance<D extends SerializedData> {
+    /**
+     * Returns a {@link StarlightItemResponse} with a single {@link ModelCategory}.
+     *
+     * @example Requesting information from a category called "articles" in a model of slug "posts".
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.posts.articles.get()
+     * ```
+     */
     get(): Promise<StarlightItemResponse<ModelCategory>>;
-    entries(options?: ModelCategoryEntryListOptions<D>): Promise<StarlightListResponse<Entry<D>>>;
+    /**
+     * Returns a {@link StarlightListResponse} with the list of entries of this
+     * {@link ModelCategory}.
+     *
+     * @example Requesting all items from a category called "gaming" in a model of slug "posts".
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.posts.gaming.items()
+     * ```
+     *
+     * @example Paginating and searching on the last example.
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.posts.gaming.items({
+     *   page: 5,
+     *   query: 'kirby'
+     * })
+     * ```
+     *
+     * @param options An optional object of request parameters. See
+     * {@link ModelCategoryEntryListParams} for all available options. `field:foo`
+     * syntax is also supported, see {@link QueryableFields} for more info.
+     */
+    entries(options?: ModelCategoryEntryListParams & QueryableFields<D>): Promise<StarlightListResponse<Entry<D>>>;
 }
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/instances/ModelCategory/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EACL,aAAa,EACb,iBAAiB,EACjB,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB,oBAAY,6BAA6B,CAAC,CAAC,SAAS,cAAc,IAAI;IACpE,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,iBAAiB,CAAC,CAAC,CAAC,CAAA;AAExB,MAAM,WAAW,qBAAqB,CAAC,CAAC,SAAS,cAAc;IAC7D,GAAG,IAAI,OAAO,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC,CAAA;IACpD,OAAO,CACL,OAAO,CAAC,EAAE,6BAA6B,CAAC,CAAC,CAAC,GACzC,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;CAC5C"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/instances/ModelCategory/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,KAAK,EACL,aAAa,EACb,eAAe,EACf,0BAA0B,EAC1B,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB;;;;;;GAMG;AACH,MAAM,WAAW,4BACf,SAAQ,qBAAqB,EAC3B,0BAA0B;IAC5B;;;OAGG;IACH,KAAK,CAAC,EACF,WAAW,GACX,YAAY,GACZ,kBAAkB,GAClB,mBAAmB,GACnB,WAAW,GACX,YAAY,CAAA;CACjB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC,SAAS,cAAc;IAC7D;;;;;;;;;OASG;IACH,GAAG,IAAI,OAAO,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC,CAAA;IAEpD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,OAAO,CACL,OAAO,CAAC,EAAE,4BAA4B,GAAG,eAAe,CAAC,CAAC,CAAC,GAC1D,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;CAC5C"}

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/instances/ModelCategory/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  Entry,\n  ModelCategory,\n  ModelFieldOptions,\n  SerializedData,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\n\nexport type ModelCategoryEntryListOptions<D extends SerializedData> = {\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} & ModelFieldOptions<D>\n\nexport interface ModelCategoryInstance<D extends SerializedData> {\n  get(): Promise<StarlightItemResponse<ModelCategory>>\n  entries(\n    options?: ModelCategoryEntryListOptions<D>\n  ): Promise<StarlightListResponse<Entry<D>>>\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/instances/ModelCategory/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  BaseRequestParameters,\n  Entry,\n  ModelCategory,\n  QueryableFields,\n  QueryableRequestParameters,\n  SerializedData,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\n\n/**\n * Request parameters for listing category entries.\n *\n * Used by {@apilink ModelCategoryInstance.entries}.\n *\n * @group Request Parameters\n */\nexport interface ModelCategoryEntryListParams\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 from a\n * {@link ModelCategory} and its {@apilink Entry | Entries}.\n *\n * You can access a ModelCategoryInstance using\n * {@apilink ModelInstance.category} or using the dynamic syntax on a\n * {@link DynamicModelInstance}. Usage examples will use the dynamic syntax.\n *\n * To list all categories from a model, use a {@link ModelCategorySelector}.\n *\n * @group Instances\n */\nexport interface ModelCategoryInstance<D extends SerializedData> {\n  /**\n   * Returns a {@link StarlightItemResponse} with a single {@link ModelCategory}.\n   *\n   * @example Requesting information from a category called \"articles\" in a model of slug \"posts\".\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.posts.articles.get()\n   * ```\n   */\n  get(): Promise<StarlightItemResponse<ModelCategory>>\n\n  /**\n   * Returns a {@link StarlightListResponse} with the list of entries of this\n   * {@link ModelCategory}.\n   *\n   * @example Requesting all items from a category called \"gaming\" in a model of slug \"posts\".\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.posts.gaming.items()\n   * ```\n   *\n   * @example Paginating and searching on the last example.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.posts.gaming.items({\n   *   page: 5,\n   *   query: 'kirby'\n   * })\n   * ```\n   *\n   * @param options An optional object of request parameters. See\n   * {@link ModelCategoryEntryListParams} for all available options. `field:foo`\n   * syntax is also supported, see {@link QueryableFields} for more info.\n   */\n  entries(\n    options?: ModelCategoryEntryListParams & QueryableFields<D>\n  ): Promise<StarlightListResponse<Entry<D>>>\n}\n"]}

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

@@ -1,5 +1,5 @@
 import { StarlightClient } from '../../types';
-import { CollectionSelector, ProxiedCollectionSelector } from './types';
-export default function makeCollectionSelector(client: StarlightClient): ProxiedCollectionSelector;
-export { CollectionSelector, ProxiedCollectionSelector };
+import { CollectionSelector, DynamicCollectionSelector, ListCollectionsParams } from './types';
+export default function makeCollectionSelector(client: StarlightClient): DynamicCollectionSelector;
+export { CollectionSelector, DynamicCollectionSelector, ListCollectionsParams };
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Collection/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAA;AAGvE,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAC5C,MAAM,EAAE,eAAe,GACtB,yBAAyB,CAoB3B;AAED,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Collection/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EACL,kBAAkB,EAClB,yBAAyB,EACzB,qBAAqB,EACtB,MAAM,SAAS,CAAA;AAGhB,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAC5C,MAAM,EAAE,eAAe,GACtB,yBAAyB,CAoB3B;AAED,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,CAAA"}

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

@@ -2,7 +2,7 @@ import makeCollectionInstance from '../../instances/Collection';
 export default function makeCollectionSelector(client) {
     const selector = {
         list(options) {
-            return client.get('/collections', options);
+            return client.get('/collections', Object.assign({}, options));
         },
         get(slug) {
             return client.get(`/collections/${slug}`);

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Collection/index.ts"],"names":[],"mappings":"AAEA,OAAO,sBAAsB,MAAM,4BAA4B,CAAA;AAE/D,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAC5C,MAAuB;IAEvB,MAAM,QAAQ,GAAuB;QACnC,IAAI,CAAC,OAAO;YACV,OAAO,MAAM,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAA;QAC5C,CAAC;QAED,GAAG,CAAC,IAAI;YACN,OAAO,MAAM,CAAC,GAAG,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAA;QAC3C,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,sBAAsB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;aAC5C;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAA8B,CAAA;AACjC,CAAC","sourcesContent":["import { StarlightClient } from '../../types'\nimport { CollectionSelector, ProxiedCollectionSelector } from './types'\nimport makeCollectionInstance from '../../instances/Collection'\n\nexport default function makeCollectionSelector(\n  client: StarlightClient\n): ProxiedCollectionSelector {\n  const selector: CollectionSelector = {\n    list(options) {\n      return client.get('/collections', options)\n    },\n\n    get(slug) {\n      return client.get(`/collections/${slug}`)\n    },\n  }\n\n  return new Proxy(selector, {\n    get(target, prop) {\n      if (typeof prop === 'string' && !Reflect.has(target, prop)) {\n        return makeCollectionInstance(client, prop)\n      }\n\n      return Reflect.get(target, prop)\n    },\n  }) as ProxiedCollectionSelector\n}\n\nexport { CollectionSelector, ProxiedCollectionSelector }\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Collection/index.ts"],"names":[],"mappings":"AAMA,OAAO,sBAAsB,MAAM,4BAA4B,CAAA;AAE/D,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAC5C,MAAuB;IAEvB,MAAM,QAAQ,GAAuB;QACnC,IAAI,CAAC,OAAO;YACV,OAAO,MAAM,CAAC,GAAG,CAAC,cAAc,oBAAO,OAAO,EAAG,CAAA;QACnD,CAAC;QAED,GAAG,CAAC,IAAI;YACN,OAAO,MAAM,CAAC,GAAG,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAA;QAC3C,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,sBAAsB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;aAC5C;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAA8B,CAAA;AACjC,CAAC","sourcesContent":["import { StarlightClient } from '../../types'\nimport {\n  CollectionSelector,\n  DynamicCollectionSelector,\n  ListCollectionsParams,\n} from './types'\nimport makeCollectionInstance from '../../instances/Collection'\n\nexport default function makeCollectionSelector(\n  client: StarlightClient\n): DynamicCollectionSelector {\n  const selector: CollectionSelector = {\n    list(options) {\n      return client.get('/collections', { ...options })\n    },\n\n    get(slug) {\n      return client.get(`/collections/${slug}`)\n    },\n  }\n\n  return new Proxy(selector, {\n    get(target, prop) {\n      if (typeof prop === 'string' && !Reflect.has(target, prop)) {\n        return makeCollectionInstance(client, prop)\n      }\n\n      return Reflect.get(target, prop)\n    },\n  }) as DynamicCollectionSelector\n}\n\nexport { CollectionSelector, DynamicCollectionSelector, ListCollectionsParams }\n"]}

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

@@ -1,16 +1,91 @@
-import { Collection, StarlightItemResponse, StarlightListResponse } from '../../types';
+import { BaseRequestParameters, Collection, StarlightItemResponse, StarlightListResponse } from '../../types';
 import { CollectionInstance } from '../../instances/Collection';
-export declare type ListCollectionsOptions = {
-    query?: string;
-    page?: number;
-    limit?: number;
+/**
+ * Request parameters for listing collections.
+ *
+ * Used by {@apilink CollectionSelector.list}.
+ *
+ * @group Request Parameters
+ */
+export interface ListCollectionsParams extends BaseRequestParameters {
+    /**
+     * Define how items will be ordered. Check this field type to see the
+     * allowed options.
+     */
     order?: 'title:asc' | 'title:desc' | 'item_count:asc' | 'item_count:desc';
-};
+}
+/**
+ * A Selector that provide methods to list and request information on
+ * {@apilink Collection | Collections}.
+ *
+ * You can use a CollectionSelector by accessing
+ * {@apilink StarlightClient.collections}.
+ *
+ * To get items from a specific collection, use a {@link CollectionInstance}.
+ *
+ * @group Selectors
+ */
 export interface CollectionSelector {
-    list(options?: ListCollectionsOptions): Promise<StarlightListResponse<Collection>>;
+    /**
+     * Returns a {@link StarlightListResponse} with the list of
+     * {@apilink Collection | Collections} in this workspace.
+     *
+     * @example Requesting all collections from the workspace.
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.collections.list()
+     * ```
+     *
+     * @example Paginating and searching on the last example.
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.collections.list({
+     *   page: 2,
+     *   query: 'photos',
+     * })
+     * ```
+     *
+     * @param options An optional object of request parameters. See
+     * {@link ListCollectionsParams} for all available options.
+     */
+    list(options?: ListCollectionsParams): Promise<StarlightListResponse<Collection>>;
+    /**
+     * Returns a {@link StarlightItemResponse} with a single {@link Collection}.
+     *
+     * @example Requesting information from a collection of slug "event-photos".
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.collections.get('event-photos')
+     * ```
+     *
+     * @param slug The collection slug.
+     */
     get(slug: string | number): Promise<StarlightItemResponse<Collection>>;
 }
-export declare type ProxiedCollectionSelector = CollectionSelector & {
-    [key: string]: CollectionInstance;
+/**
+ * A Selector that provide all {@link CollectionSelector} methods and adds
+ * support for creating {@apilink CollectionInstance | CollectionInstances}
+ * using the dynamic syntax.
+ *
+ * See {@link CollectionSelector} 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 CollectionInstance using the dynamic syntax.
+ * ```ts
+ * import Starlight from '@starlightcms/js-sdk'
+ *
+ * // "sliders" below will be a CollectionInstance.
+ * const response = await Starlight.collections.sliders.list()
+ * ```
+ *
+ * @category Instances
+ */
+export declare type DynamicCollectionSelector = CollectionSelector & {
+    [key: string]: CollectionInstance<unknown>;
 };
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Collection/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAE/D,oBAAY,sBAAsB,GAAG;IACnC,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,gBAAgB,GAAG,iBAAiB,CAAA;CAC1E,CAAA;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,CACF,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,CAAA;IAC7C,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,CAAA;CACvE;AAED,oBAAY,yBAAyB,GAAG,kBAAkB,GAAG;IAC3D,CAAC,GAAG,EAAE,MAAM,GAAG,kBAAkB,CAAA;CAClC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Collection/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,UAAU,EACV,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAE/D;;;;;;GAMG;AACH,MAAM,WAAW,qBAAsB,SAAQ,qBAAqB;IAClE;;;OAGG;IACH,KAAK,CAAC,EAAE,WAAW,GAAG,YAAY,GAAG,gBAAgB,GAAG,iBAAiB,CAAA;CAC1E;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,CAAA;IAE7C;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,CAAA;CACvE;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,oBAAY,yBAAyB,GAAG,kBAAkB,GAAG;IAC3D,CAAC,GAAG,EAAE,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAA;CAC3C,CAAA"}

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Collection/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  Collection,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\nimport { CollectionInstance } from '../../instances/Collection'\n\nexport type ListCollectionsOptions = {\n  query?: string\n  page?: number\n  limit?: number\n  order?: 'title:asc' | 'title:desc' | 'item_count:asc' | 'item_count:desc'\n}\n\nexport interface CollectionSelector {\n  list(\n    options?: ListCollectionsOptions\n  ): Promise<StarlightListResponse<Collection>>\n  get(slug: string | number): Promise<StarlightItemResponse<Collection>>\n}\n\nexport type ProxiedCollectionSelector = CollectionSelector & {\n  [key: string]: CollectionInstance\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Collection/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  BaseRequestParameters,\n  Collection,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\nimport { CollectionInstance } from '../../instances/Collection'\n\n/**\n * Request parameters for listing collections.\n *\n * Used by {@apilink CollectionSelector.list}.\n *\n * @group Request Parameters\n */\nexport interface ListCollectionsParams 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' | 'item_count:asc' | 'item_count:desc'\n}\n\n/**\n * A Selector that provide methods to list and request information on\n * {@apilink Collection | Collections}.\n *\n * You can use a CollectionSelector by accessing\n * {@apilink StarlightClient.collections}.\n *\n * To get items from a specific collection, use a {@link CollectionInstance}.\n *\n * @group Selectors\n */\nexport interface CollectionSelector {\n  /**\n   * Returns a {@link StarlightListResponse} with the list of\n   * {@apilink Collection | Collections} in this workspace.\n   *\n   * @example Requesting all collections from the workspace.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.collections.list()\n   * ```\n   *\n   * @example Paginating and searching on the last example.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.collections.list({\n   *   page: 2,\n   *   query: 'photos',\n   * })\n   * ```\n   *\n   * @param options An optional object of request parameters. See\n   * {@link ListCollectionsParams} for all available options.\n   */\n  list(\n    options?: ListCollectionsParams\n  ): Promise<StarlightListResponse<Collection>>\n\n  /**\n   * Returns a {@link StarlightItemResponse} with a single {@link Collection}.\n   *\n   * @example Requesting information from a collection of slug \"event-photos\".\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.collections.get('event-photos')\n   * ```\n   *\n   * @param slug The collection slug.\n   */\n  get(slug: string | number): Promise<StarlightItemResponse<Collection>>\n}\n\n/**\n * A Selector that provide all {@link CollectionSelector} methods and adds\n * support for creating {@apilink CollectionInstance | CollectionInstances}\n * using the dynamic syntax.\n *\n * See {@link CollectionSelector} 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 CollectionInstance using the dynamic syntax.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * // \"sliders\" below will be a CollectionInstance.\n * const response = await Starlight.collections.sliders.list()\n * ```\n *\n * @category Instances\n */\nexport type DynamicCollectionSelector = CollectionSelector & {\n  [key: string]: CollectionInstance<unknown>\n}\n"]}

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

@@ -1,19 +1,114 @@
-import { Entry, ModelFieldOptions, SerializedData, StarlightItemResponse, StarlightListResponse } from '../../types';
-export declare type ListEntriesOptions<D extends SerializedData> = {
-    page?: number;
-    limit?: number;
-    query?: string;
-    'query:word'?: string;
-    fields?: string;
+import { BaseRequestParameters, Entry, QueryableFields, QueryableRequestParameters, SerializedData, StarlightItemResponse, StarlightListResponse } from '../../types';
+/**
+ * Request parameters for listing entries.
+ *
+ * Used by {@apilink EntrySelector.list}.
+ *
+ * @group Request Parameters
+ */
+export interface ListEntriesParams extends BaseRequestParameters, QueryableRequestParameters {
+    /**
+     * A comma-separated list of categories. Only entries in these categories
+     * will be returned. If undefined, all entries in the model will be listed.
+     *
+     * 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' | 'views:asc' | 'views:desc';
-    except?: number;
-} & ModelFieldOptions<D>;
+}
+/**
+ * Request parameters for getting an entry.
+ *
+ * Used by {@apilink EntrySelector.get}.
+ *
+ * @group Request Parameters
+ */
 export declare type GetEntryParams = {
+    /**
+     * Preview token generated by the Starlight admin interface. If defined and
+     * valid, the API will return a preview of the entry revision associated
+     * with the token.
+     */
     preview?: string;
 };
+/**
+ * A Selector that provide methods to list and request information on
+ * {@apilink Entry | Entries}.
+ *
+ * You can use an EntrySelector by accessing
+ * {@apilink ModelInstance.entries}.
+ *
+ * @group Selectors
+ */
 export interface EntrySelector<D extends SerializedData> {
+    /**
+     * Returns a {@link StarlightItemResponse} with a single {@link Entry}.
+     * Supports revision previewing by passing a `preview` parameter.
+     *
+     * @example Requesting information from an entry "hello-world" from a model of slug "posts".
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.posts.entries.get('hello-world')
+     * ```
+     *
+     * @example Passing a preview token on the last example.
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.posts.entries.get('hello-world', {
+     *   preview: 'CDfkvt1zTF5XhxWzi2Lejgo1'
+     * })
+     * ```
+     *
+     * @param slug The entry slug.
+     * @param params An optional object of request parameters. See
+     * {@link GetEntryParams} for all available options.
+     * @param options An optional object of Fetch parameters. Use it to modify
+     * the fetch request.See [MDN documentation on fetch()](https://developer.mozilla.org/en-US/docs/Web/API/fetch)
+     * for all available options.
+     */
     get(slug: string, params?: GetEntryParams, options?: RequestInit): Promise<StarlightItemResponse<Entry<D>>>;
-    list(options?: ListEntriesOptions<D>): Promise<StarlightListResponse<Entry<D>>>;
+    /**
+     * Returns a {@link StarlightListResponse} with a list of
+     * {@apilink Entry | Entries}.
+     *
+     * @example Requesting all entries from a model of slug "recipes".
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.recipes.entries.list()
+     * ```
+     *
+     * @example Paginating and searching on the last example.
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.recipes.entries.list({
+     *   page: 2,
+     *   query: 'gravy',
+     *   'field:is_vegan': true,
+     * })
+     * ```
+     *
+     * @example Ordering entries by number of views.
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.recipes.entries.list({
+     *   order: 'views:desc'
+     * })
+     * ```
+     *
+     * @param options An optional object of request parameters. See
+     * {@link ListEntriesParams} for all available options. `field:foo`
+     * syntax is also supported, see {@link QueryableFields} for more info.
+     */
+    list(options?: ListEntriesParams & QueryableFields<D>): Promise<StarlightListResponse<Entry<D>>>;
 }
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Entry/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EACL,iBAAiB,EACjB,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB,oBAAY,kBAAkB,CAAC,CAAC,SAAS,cAAc,IAAI;IACzD,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,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EACF,WAAW,GACX,YAAY,GACZ,kBAAkB,GAClB,mBAAmB,GACnB,WAAW,GACX,YAAY,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAA;AAExB,oBAAY,cAAc,GAAG;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,cAAc;IACrD,GAAG,CACD,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,cAAc,EACvB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAC3C,IAAI,CACF,OAAO,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,GAC9B,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;CAC5C"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Entry/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,KAAK,EACL,eAAe,EACf,0BAA0B,EAC1B,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB;;;;;;GAMG;AACH,MAAM,WAAW,iBACf,SAAQ,qBAAqB,EAC3B,0BAA0B;IAC5B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,KAAK,CAAC,EACF,WAAW,GACX,YAAY,GACZ,kBAAkB,GAClB,mBAAmB,GACnB,WAAW,GACX,YAAY,CAAA;CACjB;AAED;;;;;;GAMG;AACH,oBAAY,cAAc,GAAG;IAC3B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,cAAc;IACrD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,GAAG,CACD,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,cAAc,EACvB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,iBAAiB,GAAG,eAAe,CAAC,CAAC,CAAC,GAC/C,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;CAC5C"}

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Entry/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  Entry,\n  ModelFieldOptions,\n  SerializedData,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\n\nexport type ListEntriesOptions<D extends SerializedData> = {\n  page?: number\n  limit?: number\n  query?: string\n  'query:word'?: string\n  fields?: string\n  categories?: 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} & ModelFieldOptions<D>\n\nexport type GetEntryParams = {\n  preview?: string\n}\n\nexport interface EntrySelector<D extends SerializedData> {\n  get(\n    slug: string,\n    params?: GetEntryParams,\n    options?: RequestInit\n  ): Promise<StarlightItemResponse<Entry<D>>>\n  list(\n    options?: ListEntriesOptions<D>\n  ): Promise<StarlightListResponse<Entry<D>>>\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Entry/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  BaseRequestParameters,\n  Entry,\n  QueryableFields,\n  QueryableRequestParameters,\n  SerializedData,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\n\n/**\n * Request parameters for listing entries.\n *\n * Used by {@apilink EntrySelector.list}.\n *\n * @group Request Parameters\n */\nexport interface ListEntriesParams\n  extends BaseRequestParameters,\n    QueryableRequestParameters {\n  /**\n   * A comma-separated list of categories. Only entries in these categories\n   * will be returned. If undefined, all entries in the model will be listed.\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    | 'views:asc'\n    | 'views:desc'\n}\n\n/**\n * Request parameters for getting an entry.\n *\n * Used by {@apilink EntrySelector.get}.\n *\n * @group Request Parameters\n */\nexport type GetEntryParams = {\n  /**\n   * Preview token generated by the Starlight admin interface. If defined and\n   * valid, the API will return a preview of the entry revision associated\n   * with the token.\n   */\n  preview?: string\n}\n\n/**\n * A Selector that provide methods to list and request information on\n * {@apilink Entry | Entries}.\n *\n * You can use an EntrySelector by accessing\n * {@apilink ModelInstance.entries}.\n *\n * @group Selectors\n */\nexport interface EntrySelector<D extends SerializedData> {\n  /**\n   * Returns a {@link StarlightItemResponse} with a single {@link Entry}.\n   * Supports revision previewing by passing a `preview` parameter.\n   *\n   * @example Requesting information from an entry \"hello-world\" from a model of slug \"posts\".\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.posts.entries.get('hello-world')\n   * ```\n   *\n   * @example Passing a preview token on the last example.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.posts.entries.get('hello-world', {\n   *   preview: 'CDfkvt1zTF5XhxWzi2Lejgo1'\n   * })\n   * ```\n   *\n   * @param slug The entry slug.\n   * @param params An optional object of request parameters. See\n   * {@link GetEntryParams} for all available options.\n   * @param options An optional object of Fetch parameters. Use it to modify\n   * the fetch request.See [MDN documentation on fetch()](https://developer.mozilla.org/en-US/docs/Web/API/fetch)\n   * for all available options.\n   */\n  get(\n    slug: string,\n    params?: GetEntryParams,\n    options?: RequestInit\n  ): Promise<StarlightItemResponse<Entry<D>>>\n\n  /**\n   * Returns a {@link StarlightListResponse} with a list of\n   * {@apilink Entry | Entries}.\n   *\n   * @example Requesting all entries from a model of slug \"recipes\".\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.recipes.entries.list()\n   * ```\n   *\n   * @example Paginating and searching on the last example.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.recipes.entries.list({\n   *   page: 2,\n   *   query: 'gravy',\n   *   'field:is_vegan': true,\n   * })\n   * ```\n   *\n   * @example Ordering entries by number of views.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.recipes.entries.list({\n   *   order: 'views:desc'\n   * })\n   * ```\n   *\n   * @param options An optional object of request parameters. See\n   * {@link ListEntriesParams} for all available options. `field:foo`\n   * syntax is also supported, see {@link QueryableFields} for more info.\n   */\n  list(\n    options?: ListEntriesParams & QueryableFields<D>\n  ): Promise<StarlightListResponse<Entry<D>>>\n}\n"]}

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

@@ -3,8 +3,8 @@ export default function makeMediaSelector(client) {
         list() {
             return client.get('/media');
         },
-        get(slug) {
-            return client.get(`/media/${slug}`);
+        get(id) {
+            return client.get(`/media/${id}`);
         },
     };
 }

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Media/index.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,OAAO,UAAU,iBAAiB,CACvC,MAAuB;IAEvB,OAAO;QACL,IAAI;YACF,OAAO,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAC7B,CAAC;QAED,GAAG,CAAC,IAAI;YACN,OAAO,MAAM,CAAC,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC,CAAA;QACrC,CAAC;KACF,CAAA;AACH,CAAC","sourcesContent":["import { StarlightClient } from '../../types'\nimport { MediaSelector } from './types'\n\nexport default function makeMediaSelector(\n  client: StarlightClient\n): MediaSelector {\n  return {\n    list() {\n      return client.get('/media')\n    },\n\n    get(slug) {\n      return client.get(`/media/${slug}`)\n    },\n  }\n}\n\nexport { MediaSelector }\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Media/index.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,OAAO,UAAU,iBAAiB,CACvC,MAAuB;IAEvB,OAAO;QACL,IAAI;YACF,OAAO,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAC7B,CAAC;QAED,GAAG,CAAC,EAAE;YACJ,OAAO,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,CAAC,CAAA;QACnC,CAAC;KACF,CAAA;AACH,CAAC","sourcesContent":["import { StarlightClient } from '../../types'\nimport { MediaSelector } from './types'\n\nexport default function makeMediaSelector(\n  client: StarlightClient\n): MediaSelector {\n  return {\n    list() {\n      return client.get('/media')\n    },\n\n    get(id) {\n      return client.get(`/media/${id}`)\n    },\n  }\n}\n\nexport { MediaSelector }\n"]}

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

@@ -1,6 +1,40 @@
 import { MediaObject, StarlightItemResponse, StarlightListResponse } from '../../types';
+/**
+ * A Selector that provide methods to list and request information on
+ * {@apilink MediaObject | MediaObjects}.
+ *
+ * You can use a MediaSelector by accessing
+ * {@apilink StarlightClient.media}.
+ *
+ * @group Selectors
+ */
 export interface MediaSelector {
-    get(slug: number | string): Promise<StarlightItemResponse<MediaObject>>;
+    /**
+     * Returns a {@link StarlightItemResponse} with a single {@link MediaObject}.
+     *
+     * Note: MediaObjects are identified by their IDs, since they don't have slugs.
+     *
+     * @example Requesting information from a media object of id "123456789".
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.media.get('123456789')
+     * ```
+     *
+     * @param id The media object ID.
+     */
+    get(id: number | string): Promise<StarlightItemResponse<MediaObject>>;
+    /**
+     * Returns a {@link StarlightListResponse} with the list of
+     * {@apilink MediaObject | MediaObjects} in this workspace.
+     *
+     * @example Requesting all media objects from the workspace.
+     * ```ts
+     * import Starlight from '@starlightcms/js-sdk'
+     *
+     * const response = await Starlight.media.list()
+     * ```
+     */
     list(): Promise<StarlightListResponse<MediaObject>>;
 }
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Media/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB,MAAM,WAAW,aAAa;IAC5B,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC,CAAA;IACvE,IAAI,IAAI,OAAO,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC,CAAA;CACpD"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Media/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC,CAAA;IAErE;;;;;;;;;;OAUG;IACH,IAAI,IAAI,OAAO,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC,CAAA;CACpD"}