@starlightcms/js-sdk 0.9.0 → 0.11.0

package/dist/cjs/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/cjs/selectors/ModelCategory/index.js

@@ -7,7 +7,7 @@ const ModelCategory_1 = __importDefault(require("../../instances/ModelCategory")
 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/cjs/selectors/ModelCategory/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/ModelCategory/index.ts"],"names":[],"mappings":";;;;;AAQA,kFAAqE;AAErE,SAAwB,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,IAAA,uBAAyB,EAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;aACtD;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAAoC,CAAA;AACvC,CAAC;AAvBD,4CAuBC","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,kFAAqE;AAErE,SAAwB,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,IAAA,uBAAyB,EAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;aACtD;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAAoC,CAAA;AACvC,CAAC;AAvBD,4CAuBC","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/cjs/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/cjs/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/cjs/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/cjs/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/cjs/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/cjs/selectors/Search/index.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 function makeSearchSelector(client) {
     return {
         entries(options) {
-            return client.get('/search/entries', options);
+            return client.get('/search/entries', Object.assign({}, options));
         },
     };
 }

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Search/index.ts"],"names":[],"mappings":";;AAQA,SAAwB,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;AAVD,qCAUC","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,SAAwB,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;AAVD,qCAUC","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/cjs/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/cjs/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/cjs/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/cjs/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/cjs/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/cjs/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"]}

package/dist/cjs/types/entities.d.ts

@@ -1,13 +1,28 @@
+/**
+ * Base interface used by all entities returned by the API.
+ *
+ * @internal
+ */
 interface StarlightEntity {
     id: number;
     created_at: string;
     updated_at?: string;
 }
+/**
+ * Represents a Model Category entity returned by the API.
+ *
+ * @group API Entities
+ */
 export interface ModelCategory extends StarlightEntity {
     title: string;
     slug: string;
     entry_count?: number;
 }
+/**
+ * Represents a Media File entity returned by the API.
+ *
+ * @group API Entities
+ */
 export interface MediaFile extends StarlightEntity {
     variation: string;
     path: string;
@@ -16,6 +31,11 @@ export interface MediaFile extends StarlightEntity {
     filesize: number;
     meta?: Record<string, unknown>;
 }
+/**
+ * Represents a Media Object entity returned by the API.
+ *
+ * @group API Entities
+ */
 export interface MediaObject extends StarlightEntity {
     name: string;
     extension: string;
@@ -24,19 +44,162 @@ export interface MediaObject extends StarlightEntity {
     alt?: string;
     description?: string;
 }
+/**
+ * Represents an Author entity returned by the API. Authors are returned in
+ * {@link Entry} requests.
+ *
+ * @group API Entities
+ */
 export interface Author {
     id: number;
     name: string;
 }
+/**
+ * Represents a Model entity returned by the API.
+ *
+ * @group API Entities
+ */
 export interface Model extends StarlightEntity {
     title: string;
     slug: string;
     entry_count?: number;
 }
+/**
+ * Represents content data returned by either an {@link Entry} or
+ * {@link Singleton} entity from the API.
+ *
+ * This is a utility type used internally by the SDK and you don't
+ * need to use it. Its purpose is to constraint Entry and Singleton
+ * data to the shape of a JS object.
+ *
+ * @category Internal Types
+ */
 export declare type SerializedData = Record<string, unknown> | undefined;
-export declare type ModelFieldOptions<D extends SerializedData> = {
-    [K in keyof D as `field:${string & K}`]?: string;
+/**
+ * Utility type that creates a string map of all fields of the given
+ * SerializedData type with the `field:` prefix. This syntax allows to filter
+ * specific fields when listing {@apilink Entry | Entries}:
+ *
+ * - Text fields can be filtered by a string query. This works just like
+ *   passing a `query` parameter, but it only applies to one field.
+ * - Boolean fields can be filtered by "true" or "false".
+ *
+ * If a request uses this type, it means that this syntax can be used in their
+ * parameters:
+ *
+ * ```ts
+ * import Starlight from '@starlightcms/js-sdk'
+ *
+ * const response = await Starlight.posts.entries.list({
+ *   // EntrySelector.list() supports the "field:foo" syntax:
+ *   'field:content': 'hello world',
+ *   'field:is_featured': true,
+ *
+ *   // EntrySelector.list() also support other parameters,
+ *   // which are passed in this object too:
+ *   page: 42,
+ *   limit: 20,
+ * })
+ * ```
+ *
+ * @remark
+ *
+ * The information below is only useful for SDK maintainers.
+ *
+ * This type receives a {@link SerializedData}-like structure, like an object.
+ * For instance, for an {@link Entry} with fields "content" and "summary",
+ * the generated type would look like this:
+ *
+ * ```ts
+ * type GeneratedType = {
+ *   'field:content'?: string
+ *   'field:summary'?: string
+ * }
+ * ```
+ *
+ * However, note that QueryableFields receive a {@link SerializedData}, not an
+ * {@link Entry}:
+ *
+ * ```ts
+ * import { VisualField, StringField } from '@starlightcms/js-sdk'
+ *
+ * type EntryFields = {
+ *   content: VisualField
+ *   summary: StringField
+ * }
+ *
+ * type MyEntry = Entry<EntryFields>
+ *
+ * // Error TS2344: Type does not satisfy the constraint 'SerializedData'
+ * type GeneratedType = QueryableFields<MyEntry>
+ *
+ * // Works!
+ * type GeneratedType = QueryableFields<EntryFields>
+ * ```
+ *
+ * This type is only useful to request methods that support
+ * field querying using the "field:foo" syntax.
+ *
+ * @category Internal Types
+ */
+export declare type QueryableFields<D extends SerializedData> = {
+    [K in keyof D as `field:${string & K}`]?: string | boolean;
 };
+/**
+ * Utility type that return {@link QueryableFields} if the given type T
+ * is an {@link Entry} or a {@link Singleton}, but generates an empty object
+ * otherwise.
+ *
+ * Fun fact: internally, Entries and Singletons have parent Models,
+ * which is why they are called "modelables" here.
+ *
+ * @category Internal Types
+ */
+export declare type WithQueryableFieldsOnModelables<T> = T extends Entry<never> | Singleton<never> ? QueryableFields<Pick<T, 'data'>> : Record<string, never>;
+/**
+ * Represents an Entry entity returned by the API.
+ *
+ * An Entry's `data` field can be further typed by passing an object-like
+ * structure as the D generic type. This is useful to provide type-safety to
+ * your application, since the `data` field is a generic JS object by default.
+ *
+ * It's recommended to use the Field types provided by this SDK to type your
+ * entities using a type definition file on your project. For instance:
+ *
+ * ```ts
+ * // starlight.d.ts file
+ * import { VisualField, MediaField } from '@starlightcms/js-sdk'
+ *
+ * type PostFields = {
+ *   featured_image: MediaField
+ *   content: VisualField
+ * }
+ *
+ * declare module '@starlightcms/js-sdk' {
+ *   export interface DefaultModelDefinition {
+ *     posts: PostFields
+ *   }
+ * }
+ * ```
+ *
+ * You can place this type definition file anywhere in your repository, but it's
+ * good practice to place it at the same level as your root index.ts file. Then,
+ * in your files, all SDK calls will correctly type `posts`:
+ *
+ * ```ts
+ * import Starlight from '@starlightcms/js-sdk'
+ *
+ * // response type will be StarlightItemResponse<Entry<PostFields>> on request success
+ * const response = await Starlight.posts.entries.get('hello-world')
+ *
+ * // helloWorld type is Entry<PostFields>
+ * const helloWorld = response.data
+ * ```
+ *
+ * See {@apilink DefaultModelDefinition} for more info.
+ *
+ * @group API Entities
+ */
 export interface Entry<D extends SerializedData> extends Omit<StarlightEntity, 'created_at'> {
     title: string;
     slug: string;
@@ -46,21 +209,97 @@ export interface Entry<D extends SerializedData> extends Omit<StarlightEntity, '
     category: ModelCategory | null;
     published_at: string | null;
 }
+/**
+ * Represents a Singleton entity returned by the API.
+ *
+ * A Singleton's `data` field can be further typed by passing an object-like
+ * structure as the D generic type. This is useful to provide type-safety to
+ * your application, since the `data` field is a generic JS object by default.
+ *
+ * It's recommended to use the Field types provided by this SDK to type your
+ * Singletons. For instance:
+ *
+ * ```ts
+ * import { StringField, VisualField, MediaField } from '@starlightcms/js-sdk'
+ *
+ * type HomeFields = {
+ *   site_title: StringField
+ *   hero_image: MediaField
+ *   hero_content: VisualField
+ * }
+ *
+ * // response type will be StarlightItemResponse<Singleton<HomeFields>> on request success
+ * const response = Starlight.singletons.get<HomeFields>('home')
+ *
+ * // home type is Singleton<HomeFields>
+ * const home = response.data
+ * ```
+ *
+ * You could also place all your Singleton field types in the same type
+ * definition file used to configure Entry fields, which makes it easier to
+ * import these types in other files on your project. See
+ * {@apilink DefaultModelDefinition} for more info.
+ *
+ * @group API Entities
+ */
 export interface Singleton<D extends SerializedData> extends Omit<StarlightEntity, 'created_at'> {
     title: string;
     slug: string;
     data: D;
     published_at: string | null;
 }
+/**
+ * Currently supported Collection types. This type is mainly used to provide
+ * autocompletion on IDEs, since it lets users use any string as well as the
+ * known supported types.
+ *
+ * @internal
+ */
 export declare type CollectionTypes = 'entry' | 'singleton' | 'media' | string;
+/**
+ * Currently supported Collection entities. This type is mainly used to infer
+ * the collection type string (see {@link CollectionTypes}) from the type of
+ * entity that that Collection holds.
+ *
+ * @internal
+ */
+export declare type CollectionEntityTypes = Entry<never> | Singleton<never> | MediaObject | unknown;
+/**
+ * Infers a Collection type from an entity type. See {@link CollectionTypes} and
+ * {@link CollectionEntityTypes} to know more.
+ *
+ * @internal
+ */
+export declare type CollectionTypeMapper<T extends CollectionEntityTypes> = T extends Entry<any> ? 'entry' : T extends Singleton<any> ? 'singleton' : T extends MediaObject ? 'media' : string;
+/**
+ * Represents a Collection entity returned by the API.
+ *
+ * You can request collections using a {@link CollectionInstance} or a
+ * {@link CollectionSelector}.
+ *
+ * @group API Entities
+ */
 export interface Collection<T extends CollectionTypes = string> extends StarlightEntity {
     title: string;
     slug: string;
     type: T;
     item_count?: number;
 }
+/**
+ * Currently supported Relation types.
+ */
 declare type RelationTypes = Entry<never> | Singleton<never> | MediaObject | Collection | unknown;
+/**
+ * Represents a Relation entity returned by the API.
+ *
+ * @group API Entities
+ */
 export interface Relation<T extends RelationTypes> {
+    /**
+     * The relation type, which is always a string. If the `object` field of this
+     * Relation is an Entry, type will be `entry`, if it's a Singleton, type will
+     * be `singleton`, and so on.
+     */
     type: T extends Entry<never> ? 'entry' : T extends Singleton<never> ? 'singleton' : T extends MediaObject ? 'media' : T extends Collection ? 'collection' : string;
     id: number;
     object: T;