@starlightcms/js-sdk 0.9.0 → 0.11.0

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

@@ -0,0 +1,8 @@
+export { ModelCategorySelector, DynamicModelCategorySelector, } from '../selectors/ModelCategory';
+export { ModelSelector, DynamicModelSelector } from '../selectors/Model';
+export { CollectionSelector, DynamicCollectionSelector, ListCollectionsParams, } from '../selectors/Collection';
+export { EntrySelector } from '../selectors/Entry';
+export { MediaSelector } from '../selectors/Media';
+export { SearchSelector, SearchEntriesParams } from '../selectors/Search';
+export { SingletonSelector } from '../selectors/Singleton';
+//# sourceMappingURL=selectors.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"selectors.d.ts","sourceRoot":"","sources":["../../../src/types/selectors.ts"],"names":[],"mappings":"AACA,OAAO,EACL,qBAAqB,EACrB,4BAA4B,GAC7B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAA;AACxE,OAAO,EACL,kBAAkB,EAClB,yBAAyB,EACzB,qBAAqB,GACtB,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AACzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA"}

package/dist/esm/types/selectors.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=selectors.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"selectors.js","sourceRoot":"","sources":["../../../src/types/selectors.ts"],"names":[],"mappings":"","sourcesContent":["// Selector types are exported here so they are visible in the API docs.\nexport {\n  ModelCategorySelector,\n  DynamicModelCategorySelector,\n} from '../selectors/ModelCategory'\nexport { ModelSelector, DynamicModelSelector } from '../selectors/Model'\nexport {\n  CollectionSelector,\n  DynamicCollectionSelector,\n  ListCollectionsParams,\n} from '../selectors/Collection'\nexport { EntrySelector } from '../selectors/Entry'\nexport { MediaSelector } from '../selectors/Media'\nexport { SearchSelector, SearchEntriesParams } from '../selectors/Search'\nexport { SingletonSelector } from '../selectors/Singleton'\n"]}

package/dist/esm/types/visual.d.ts

@@ -1,23 +1,61 @@
+/**
+ * All supported block types.
+ *
+ * @group Visual Data Blocks
+ * @internal
+ */
 export declare type BlockType = 'paragraph' | 'quote' | 'header' | 'image' | 'raw' | 'list';
+/**
+ * Base interface for types that represent block data.
+ *
+ * @group Visual Data Blocks
+ */
 export interface BlockData {
     [key: string]: unknown;
 }
+/**
+ * Represents a Paragraph block, which is the default block type used
+ * for text content in the Visual Editor.
+ *
+ * @group Visual Data Blocks
+ */
 export interface ParagraphBlock extends BlockData {
     text: string;
 }
+/**
+ * Represents a Header block, which is used to render h1 through h6 HTML elements.
+ *
+ * @group Visual Data Blocks
+ */
 export interface HeaderBlock extends BlockData {
     text: string;
     level: number;
 }
+/**
+ * Represents a Quote block, which is used to render a blockquote HTML element.
+ *
+ * @group Visual Data Blocks
+ */
 export interface QuoteBlock extends BlockData {
     text: string;
     caption: string;
     alignment: 'left' | 'center';
 }
+/**
+ * Represents an image file, used in Image blocks.
+ *
+ * @group Visual Data Blocks
+ * @internal
+ */
 declare type ImageFile = {
     url: string;
     width: number;
 };
+/**
+ * Represents an Image block, which is used to render img or picture HTML elements.
+ *
+ * @group Visual Data Blocks
+ */
 export interface ImageBlock extends BlockData {
     id: number;
     url: string;
@@ -26,22 +64,53 @@ export interface ImageBlock extends BlockData {
     alt?: string;
     href?: string;
 }
+/**
+ * Represents an HTML block, which is used to render custom HTML code. Mainly
+ * used to place embeds or heavily customized content structures.
+ *
+ * @group Visual Data Blocks
+ */
 export interface HTMLBlock extends BlockData {
     html: string;
 }
+/**
+ * Represents a list item, which is used by List blocks.
+ *
+ * @group Visual Data Blocks
+ * @internal
+ */
 export interface ListItem {
     content: string;
     items?: ListItem[];
 }
+/**
+ * Represents a List block, which is used to render ol or ul HTML elements.
+ *
+ * @group Visual Data Blocks
+ */
 export interface ListBlock extends BlockData {
     style: 'ordered' | 'unordered';
     items: ListItem[];
 }
+/**
+ * A VisualDataBlock object represents a piece of content. Each block has a
+ * specific type and some data associated with it. For instance, a Paragraph
+ * block has text data, an Image block has a file path and image metadata, etc.
+ *
+ * @group Visual Data Blocks
+ */
 export interface VisualDataBlock<D extends BlockData = BlockData> {
     id: string;
     type: BlockType;
     data: D;
 }
+/**
+ * VisualData represents content generated by Starlight using a "Visual Editor"
+ * field. It's an object-based data representation made out of "blocks". Each
+ * block has a type string and some data associated with it.
+ *
+ * @group Visual Data Blocks
+ */
 export interface VisualData {
     time?: number;
     version?: string;

package/dist/esm/types/visual.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"visual.d.ts","sourceRoot":"","sources":["../../../src/types/visual.ts"],"names":[],"mappings":"AAAA,oBAAY,SAAS,GACjB,WAAW,GACX,OAAO,GACP,QAAQ,GACR,OAAO,GACP,KAAK,GACL,MAAM,CAAA;AAEV,MAAM,WAAW,SAAS;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED,MAAM,WAAW,cAAe,SAAQ,SAAS;IAC/C,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,WAAY,SAAQ,SAAS;IAC5C,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,UAAW,SAAQ,SAAS;IAC3C,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,GAAG,QAAQ,CAAA;CAC7B;AAED,aAAK,SAAS,GAAG;IACf,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,WAAW,UAAW,SAAQ,SAAS;IAC3C,EAAE,EAAE,MAAM,CAAA;IACV,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,SAAS,EAAE,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,SAAU,SAAQ,SAAS;IAC1C,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,QAAQ;IACvB,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAA;CACnB;AAED,MAAM,WAAW,SAAU,SAAQ,SAAS;IAC1C,KAAK,EAAE,SAAS,GAAG,WAAW,CAAA;IAC9B,KAAK,EAAE,QAAQ,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IAC9D,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,CAAC,CAAA;CACR;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,eAAe,EAAE,CAAA;CAC1B"}
+{"version":3,"file":"visual.d.ts","sourceRoot":"","sources":["../../../src/types/visual.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,oBAAY,SAAS,GACjB,WAAW,GACX,OAAO,GACP,QAAQ,GACR,OAAO,GACP,KAAK,GACL,MAAM,CAAA;AAEV;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAe,SAAQ,SAAS;IAC/C,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,SAAS;IAC5C,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAW,SAAQ,SAAS;IAC3C,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,GAAG,QAAQ,CAAA;CAC7B;AAED;;;;;GAKG;AACH,aAAK,SAAS,GAAG;IACf,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAW,SAAQ,SAAS;IAC3C,EAAE,EAAE,MAAM,CAAA;IACV,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,SAAS,EAAE,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAU,SAAQ,SAAS;IAC1C,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAA;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAU,SAAQ,SAAS;IAC1C,KAAK,EAAE,SAAS,GAAG,WAAW,CAAA;IAC9B,KAAK,EAAE,QAAQ,EAAE,CAAA;CAClB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IAC9D,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,CAAC,CAAA;CACR;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,eAAe,EAAE,CAAA;CAC1B"}

package/dist/esm/types/visual.js.map

@@ -1 +1 @@
-{"version":3,"file":"visual.js","sourceRoot":"","sources":["../../../src/types/visual.ts"],"names":[],"mappings":"","sourcesContent":["export type BlockType =\n  | 'paragraph'\n  | 'quote'\n  | 'header'\n  | 'image'\n  | 'raw'\n  | 'list'\n\nexport interface BlockData {\n  [key: string]: unknown\n}\n\nexport interface ParagraphBlock extends BlockData {\n  text: string\n}\n\nexport interface HeaderBlock extends BlockData {\n  text: string\n  level: number\n}\n\nexport interface QuoteBlock extends BlockData {\n  text: string\n  caption: string\n  alignment: 'left' | 'center'\n}\n\ntype ImageFile = {\n  url: string\n  width: number\n}\n\nexport interface ImageBlock extends BlockData {\n  id: number\n  url: string\n  files: ImageFile[]\n  caption?: string\n  alt?: string\n  href?: string\n}\n\nexport interface HTMLBlock extends BlockData {\n  html: string\n}\n\nexport interface ListItem {\n  content: string\n  items?: ListItem[]\n}\n\nexport interface ListBlock extends BlockData {\n  style: 'ordered' | 'unordered'\n  items: ListItem[]\n}\n\nexport interface VisualDataBlock<D extends BlockData = BlockData> {\n  id: string\n  type: BlockType\n  data: D\n}\n\nexport interface VisualData {\n  time?: number\n  version?: string\n  blocks: VisualDataBlock[]\n}\n"]}
+{"version":3,"file":"visual.js","sourceRoot":"","sources":["../../../src/types/visual.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * All supported block types.\n *\n * @group Visual Data Blocks\n * @internal\n */\nexport type BlockType =\n  | 'paragraph'\n  | 'quote'\n  | 'header'\n  | 'image'\n  | 'raw'\n  | 'list'\n\n/**\n * Base interface for types that represent block data.\n *\n * @group Visual Data Blocks\n */\nexport interface BlockData {\n  [key: string]: unknown\n}\n\n/**\n * Represents a Paragraph block, which is the default block type used\n * for text content in the Visual Editor.\n *\n * @group Visual Data Blocks\n */\nexport interface ParagraphBlock extends BlockData {\n  text: string\n}\n\n/**\n * Represents a Header block, which is used to render h1 through h6 HTML elements.\n *\n * @group Visual Data Blocks\n */\nexport interface HeaderBlock extends BlockData {\n  text: string\n  level: number\n}\n\n/**\n * Represents a Quote block, which is used to render a blockquote HTML element.\n *\n * @group Visual Data Blocks\n */\nexport interface QuoteBlock extends BlockData {\n  text: string\n  caption: string\n  alignment: 'left' | 'center'\n}\n\n/**\n * Represents an image file, used in Image blocks.\n *\n * @group Visual Data Blocks\n * @internal\n */\ntype ImageFile = {\n  url: string\n  width: number\n}\n\n/**\n * Represents an Image block, which is used to render img or picture HTML elements.\n *\n * @group Visual Data Blocks\n */\nexport interface ImageBlock extends BlockData {\n  id: number\n  url: string\n  files: ImageFile[]\n  caption?: string\n  alt?: string\n  href?: string\n}\n\n/**\n * Represents an HTML block, which is used to render custom HTML code. Mainly\n * used to place embeds or heavily customized content structures.\n *\n * @group Visual Data Blocks\n */\nexport interface HTMLBlock extends BlockData {\n  html: string\n}\n\n/**\n * Represents a list item, which is used by List blocks.\n *\n * @group Visual Data Blocks\n * @internal\n */\nexport interface ListItem {\n  content: string\n  items?: ListItem[]\n}\n\n/**\n * Represents a List block, which is used to render ol or ul HTML elements.\n *\n * @group Visual Data Blocks\n */\nexport interface ListBlock extends BlockData {\n  style: 'ordered' | 'unordered'\n  items: ListItem[]\n}\n\n/**\n * A VisualDataBlock object represents a piece of content. Each block has a\n * specific type and some data associated with it. For instance, a Paragraph\n * block has text data, an Image block has a file path and image metadata, etc.\n *\n * @group Visual Data Blocks\n */\nexport interface VisualDataBlock<D extends BlockData = BlockData> {\n  id: string\n  type: BlockType\n  data: D\n}\n\n/**\n * VisualData represents content generated by Starlight using a \"Visual Editor\"\n * field. It's an object-based data representation made out of \"blocks\". Each\n * block has a type string and some data associated with it.\n *\n * @group Visual Data Blocks\n */\nexport interface VisualData {\n  time?: number\n  version?: string\n  blocks: VisualDataBlock[]\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@starlightcms/js-sdk",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "The Starlight SDK for JavaScript",
   "workspaces": [
     "website"