@starlightcms/js-sdk 0.3.1 → 0.3.5

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import { makeClient } from './client';
 export { DefaultModelDefinition } from './types';
 export { StarlightError } from './errors';
 export * from './types/fields';
+export * from './types/visual';
 declare const Starlight: import("./types").ProxiedStarlightClient<import("./types").DefaultModelDefinition>;
 export { makeClient as makeStarlightClient };
 export default Starlight;

package/dist/index.d.ts.map

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

package/dist/index.js

@@ -16,6 +16,7 @@ Object.defineProperty(exports, "makeStarlightClient", { enumerable: true, get: f
 var errors_1 = require("./errors");
 Object.defineProperty(exports, "StarlightError", { enumerable: true, get: function () { return errors_1.StarlightError; } });
 __exportStar(require("./types/fields"), exports);
+__exportStar(require("./types/visual"), exports);
 const Starlight = (0, client_1.makeClient)();
 exports.default = Starlight;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,qCAAqC;AAOd,oGAPd,mBAAU,OAOuB;AAL1C,mCAAyC;AAAhC,wGAAA,cAAc,OAAA;AACvB,iDAA8B;AAE9B,MAAM,SAAS,GAAG,IAAA,mBAAU,GAAE,CAAA;AAI9B,kBAAe,SAAS,CAAA","sourcesContent":["import { makeClient } from './client'\nexport { DefaultModelDefinition } from './types'\nexport { StarlightError } from './errors'\nexport * from './types/fields'\n\nconst Starlight = makeClient()\n\nexport { makeClient as makeStarlightClient }\n\nexport default Starlight\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,qCAAqC;AAQd,oGARd,mBAAU,OAQuB;AAN1C,mCAAyC;AAAhC,wGAAA,cAAc,OAAA;AACvB,iDAA8B;AAC9B,iDAA8B;AAE9B,MAAM,SAAS,GAAG,IAAA,mBAAU,GAAE,CAAA;AAI9B,kBAAe,SAAS,CAAA","sourcesContent":["import { makeClient } from './client'\nexport { DefaultModelDefinition } from './types'\nexport { StarlightError } from './errors'\nexport * from './types/fields'\nexport * from './types/visual'\n\nconst Starlight = makeClient()\n\nexport { makeClient as makeStarlightClient }\n\nexport default Starlight\n"]}

package/dist/types/index.d.ts

@@ -3,6 +3,7 @@ import ModelSelector from '../selectors/ModelSelector';
 import { SerializedData } from './entities';
 export * from './fields';
 export * from './entities';
+export * from './visual';
 declare type BaseUrl = 'https://query.starlight.sh/v2' | string;
 export declare type StarlightConfig = {
     workspace?: string;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,4BAA4B,CAAA;AACtD,OAAO,aAAa,MAAM,4BAA4B,CAAA;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAE3C,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAE1B,aAAK,OAAO,GAAG,+BAA+B,GAAG,MAAM,CAAA;AAEvD,oBAAY,eAAe,GAAG;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAAA;IAExC,GAAG,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IAE1D,UAAU,IAAI,MAAM,CAAA;IAEpB,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,CAAC,CAAC,CAAA;IAEb,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAAA;IAE7C,MAAM,IAAI,aAAa,CAAA;CACxB;AAED,oBAAY,sBAAsB,CAAC,CAAC,SAAS,wBAAwB,IACnE,eAAe,GAAG;KACf,CAAC,IAAI,MAAM,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACpC,CAAA;AAEH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,IAAI,EAAE,CAAC,CAAA;CACR;AAED,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,IAAI,EAAE,CAAC,EAAE,CAAA;IACT,KAAK,EAAE;QACL,KAAK,EAAE,MAAM,CAAA;QACb,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;IACD,IAAI,EAAE;QACJ,YAAY,EAAE,MAAM,CAAA;QACpB,SAAS,EAAE,MAAM,CAAA;QACjB,IAAI,EAAE,MAAM,CAAA;QACZ,EAAE,EAAE,MAAM,CAAA;QACV,QAAQ,EAAE,MAAM,CAAA;QAChB,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;CACF;AAGD,MAAM,WAAW,sBAAuB,SAAQ,wBAAwB;CAAG;AAE3E,MAAM,WAAW,wBAAwB;IACvC,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,CAAA;CAC/B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,4BAA4B,CAAA;AACtD,OAAO,aAAa,MAAM,4BAA4B,CAAA;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAE3C,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AAExB,aAAK,OAAO,GAAG,+BAA+B,GAAG,MAAM,CAAA;AAEvD,oBAAY,eAAe,GAAG;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAAA;IAExC,GAAG,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IAE1D,UAAU,IAAI,MAAM,CAAA;IAEpB,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,CAAC,CAAC,CAAA;IAEb,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAAA;IAE7C,MAAM,IAAI,aAAa,CAAA;CACxB;AAED,oBAAY,sBAAsB,CAAC,CAAC,SAAS,wBAAwB,IACnE,eAAe,GAAG;KACf,CAAC,IAAI,MAAM,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACpC,CAAA;AAEH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,IAAI,EAAE,CAAC,CAAA;CACR;AAED,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,IAAI,EAAE,CAAC,EAAE,CAAA;IACT,KAAK,EAAE;QACL,KAAK,EAAE,MAAM,CAAA;QACb,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;IACD,IAAI,EAAE;QACJ,YAAY,EAAE,MAAM,CAAA;QACpB,SAAS,EAAE,MAAM,CAAA;QACjB,IAAI,EAAE,MAAM,CAAA;QACZ,EAAE,EAAE,MAAM,CAAA;QACV,QAAQ,EAAE,MAAM,CAAA;QAChB,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;CACF;AAGD,MAAM,WAAW,sBAAuB,SAAQ,wBAAwB;CAAG;AAE3E,MAAM,WAAW,wBAAwB;IACvC,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,CAAA;CAC/B"}

package/dist/types/index.js

@@ -12,4 +12,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./fields"), exports);
 __exportStar(require("./entities"), exports);
+__exportStar(require("./visual"), exports);
 //# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAIA,2CAAwB;AACxB,6CAA0B","sourcesContent":["import EntrySelector from '../selectors/EntrySelector'\nimport ModelSelector from '../selectors/ModelSelector'\nimport { SerializedData } from './entities'\n\nexport * from './fields'\nexport * from './entities'\n\ntype BaseUrl = 'https://query.starlight.sh/v2' | string\n\nexport type StarlightConfig = {\n  workspace?: string\n  baseUrl?: BaseUrl\n  debug?: boolean\n}\n\nexport interface StarlightClient {\n  configure(config: StarlightConfig): void\n\n  log(message?: unknown, ...optionalParams: unknown[]): void\n\n  getBaseUrl(): string\n\n  get<T = Record<string, unknown>>(\n    path: string,\n    options?: RequestInit\n  ): Promise<T>\n\n  getEntrySelector(slug: string): EntrySelector\n\n  models(): ModelSelector\n}\n\nexport type ProxiedStarlightClient<T extends WorkspaceModelDefinition> =\n  StarlightClient & {\n    [K in keyof T]: EntrySelector<T[K]>\n  }\n\nexport interface StarlightItemResponse<T> {\n  data: T\n}\n\nexport interface StarlightListResponse<T> {\n  data: T[]\n  links: {\n    first: string\n    last: string\n    prev?: string\n    next?: string\n  }\n  meta: {\n    current_page: number\n    last_page: number\n    from: number\n    to: number\n    per_page: number\n    total: number\n  }\n}\n\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport interface DefaultModelDefinition extends WorkspaceModelDefinition {}\n\nexport interface WorkspaceModelDefinition {\n  [slug: string]: SerializedData\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAIA,2CAAwB;AACxB,6CAA0B;AAC1B,2CAAwB","sourcesContent":["import EntrySelector from '../selectors/EntrySelector'\nimport ModelSelector from '../selectors/ModelSelector'\nimport { SerializedData } from './entities'\n\nexport * from './fields'\nexport * from './entities'\nexport * from './visual'\n\ntype BaseUrl = 'https://query.starlight.sh/v2' | string\n\nexport type StarlightConfig = {\n  workspace?: string\n  baseUrl?: BaseUrl\n  debug?: boolean\n}\n\nexport interface StarlightClient {\n  configure(config: StarlightConfig): void\n\n  log(message?: unknown, ...optionalParams: unknown[]): void\n\n  getBaseUrl(): string\n\n  get<T = Record<string, unknown>>(\n    path: string,\n    options?: RequestInit\n  ): Promise<T>\n\n  getEntrySelector(slug: string): EntrySelector\n\n  models(): ModelSelector\n}\n\nexport type ProxiedStarlightClient<T extends WorkspaceModelDefinition> =\n  StarlightClient & {\n    [K in keyof T]: EntrySelector<T[K]>\n  }\n\nexport interface StarlightItemResponse<T> {\n  data: T\n}\n\nexport interface StarlightListResponse<T> {\n  data: T[]\n  links: {\n    first: string\n    last: string\n    prev?: string\n    next?: string\n  }\n  meta: {\n    current_page: number\n    last_page: number\n    from: number\n    to: number\n    per_page: number\n    total: number\n  }\n}\n\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport interface DefaultModelDefinition extends WorkspaceModelDefinition {}\n\nexport interface WorkspaceModelDefinition {\n  [slug: string]: SerializedData\n}\n"]}

package/dist/types/visual.d.ts

@@ -1,10 +1,30 @@
-export interface Block<D = Record<string, unknown>> {
-    type: string;
+export declare type BlockType = 'paragraph' | 'quote' | 'header' | 'image';
+interface BlockData {
+    [key: string]: unknown;
+}
+export interface ParagraphBlock extends BlockData {
+    text: string;
+}
+export interface HeaderBlock extends BlockData {
+    text: string;
+    level: number;
+}
+export interface QuoteBlock extends BlockData {
+    text: string;
+    caption: string;
+    alignment: 'left' | 'center';
+}
+export interface ImageBlock extends BlockData {
+    url: string;
+}
+export interface VisualDataBlock<D extends BlockData = BlockData> {
+    type: BlockType;
     data: D;
 }
 export interface VisualData {
     time?: number;
     version?: string;
-    blocks: Block[];
+    blocks: VisualDataBlock[];
 }
+export {};
 //# sourceMappingURL=visual.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"visual.d.ts","sourceRoot":"","sources":["../../src/types/visual.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAChD,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,CAAC,CAAA;CACR;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,KAAK,EAAE,CAAA;CAChB"}
+{"version":3,"file":"visual.d.ts","sourceRoot":"","sources":["../../src/types/visual.ts"],"names":[],"mappings":"AAAA,oBAAY,SAAS,GAAG,WAAW,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;AAElE,UAAU,SAAS;IACjB,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,MAAM,WAAW,UAAW,SAAQ,SAAS;IAC3C,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IAC9D,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"}

package/dist/types/visual.js.map

@@ -1 +1 @@
-{"version":3,"file":"visual.js","sourceRoot":"","sources":["../../src/types/visual.ts"],"names":[],"mappings":"","sourcesContent":["export interface Block<D = Record<string, unknown>> {\n  type: string\n  data: D\n}\n\nexport interface VisualData {\n  time?: number\n  version?: string\n  blocks: Block[]\n}\n"]}
+{"version":3,"file":"visual.js","sourceRoot":"","sources":["../../src/types/visual.ts"],"names":[],"mappings":"","sourcesContent":["export type BlockType = 'paragraph' | 'quote' | 'header' | 'image'\n\ninterface 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\nexport interface ImageBlock extends BlockData {\n  url: string\n}\n\nexport interface VisualDataBlock<D extends BlockData = BlockData> {\n  type: BlockType\n  data: D\n}\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.3.1",
+  "version": "0.3.5",
   "description": "The Starlight SDK for JavaScript",
   "main": "dist/index.js",
   "scripts": {
@@ -36,15 +36,13 @@
     "husky": "^7.0.2",
     "lint-staged": "^11.1.2",
     "prettier": "2.4.1",
-    "typescript": "^4.4.3"
+    "typescript": "^4.4.3",
+    "rimraf": "^3.0.2"
   },
   "lint-staged": {
     "*.{ts}": [
       "eslint --cache --fix",
       "prettier --write"
     ]
-  },
-  "dependencies": {
-    "rimraf": "^3.0.2"
   }
 }