@withstudiocms/sdk 0.1.0-beta.1 → 0.1.0

package/dist/consts.d.ts

@@ -11,6 +11,9 @@ export declare const cacheTags: {
     pages: string[];
     pageFolderTree: string[];
     middleware: string[];
+    taxonomy: string[];
+    tags: string[];
+    categories: string[];
 };
 /**
  * Functions to generate cache keys for various SDK operations.
@@ -23,6 +26,12 @@ export declare const cacheKeyGetters: {
     folderTree: () => string;
     folderList: () => string;
     page: (pageId: string) => string;
-    pageFolderTree: (hideDefaultIndex: boolean) => string;
+    pageFolderTree: () => string;
     middleware: () => string;
+    tags: () => string;
+    categories: () => string;
+    categoryById: (categoryId: number) => string;
+    categoryBySlug: (slug: string) => string;
+    tagById: (tagId: number) => string;
+    tagBySlug: (slug: string) => string;
 };

package/dist/consts.js

@@ -7,7 +7,10 @@ const cacheTags = {
   folderList: ["folder-list"],
   pages: ["pages"],
   pageFolderTree: ["page-folder-tree"],
-  middleware: ["middleware"]
+  middleware: ["middleware"],
+  taxonomy: ["taxonomy"],
+  tags: ["tags"],
+  categories: ["categories"]
 };
 const cacheKeyGetters = {
   dynamicConfig: (id) => `dynamic-config:${id}`,
@@ -17,8 +20,14 @@ const cacheKeyGetters = {
   folderTree: () => "folder-tree",
   folderList: () => "folder-list",
   page: (pageId) => `page:${pageId}`,
-  pageFolderTree: (hideDefaultIndex) => `page-folder-tree:${hideDefaultIndex}`,
-  middleware: () => "middleware"
+  pageFolderTree: () => "page-folder-tree",
+  middleware: () => "middleware",
+  tags: () => "tags",
+  categories: () => "categories",
+  categoryById: (categoryId) => `category:${categoryId}`,
+  categoryBySlug: (slug) => `category-slug:${slug}`,
+  tagById: (tagId) => `tag:${tagId}`,
+  tagBySlug: (slug) => `tag-slug:${slug}`
 };
 export {
   cacheKeyGetters,

package/dist/context.d.ts

@@ -1,19 +1,20 @@
 import { Context, Layer } from '@withstudiocms/effect';
-import type { DBClientInterface, StudioCMSDatabaseSchema } from '@withstudiocms/kysely';
+import type { DBClientInterface } from '@withstudiocms/kysely/client';
 import type { CacheEntry } from './cache.js';
+import type { StudioCMSDatabaseSchema } from './tables.js';
 declare const DBClientLive_base: Context.TagClass<DBClientLive, "@withstudiocms/sdk/context/DBClientLive", DBClientInterface<{
     readonly StudioCMSUsersTable: {
         readonly id: string;
-        readonly url: string | null | undefined;
         readonly name: string;
-        readonly email: string | null | undefined;
-        readonly avatar: string | null | undefined;
         readonly username: string;
-        readonly password: string | null | undefined;
         readonly updatedAt: import("kysely").ColumnType<string, string, string>;
-        readonly createdAt: import("kysely").ColumnType<string, string | undefined, never>;
+        readonly createdAt: import("kysely").ColumnType<string, string | undefined, undefined>;
         readonly emailVerified: number;
-        readonly notifications: string | null | undefined;
+        readonly url?: string | null | undefined;
+        readonly email?: string | null | undefined;
+        readonly avatar?: string | null | undefined;
+        readonly password?: string | null | undefined;
+        readonly notifications?: string | null | undefined;
     };
     readonly StudioCMSOAuthAccounts: {
         readonly providerUserId: string;
@@ -29,8 +30,8 @@ declare const DBClientLive_base: Context.TagClass<DBClientLive, "@withstudiocms/
         readonly id: string;
         readonly userId: string;
         readonly key: string;
-        readonly creationDate: import("kysely").ColumnType<string, string | undefined, never>;
-        readonly description: string | null | undefined;
+        readonly creationDate: import("kysely").ColumnType<string, string | undefined, undefined>;
+        readonly description?: string | null | undefined;
     };
     readonly StudioCMSUserResetTokens: {
         readonly id: string;
@@ -44,7 +45,7 @@ declare const DBClientLive_base: Context.TagClass<DBClientLive, "@withstudiocms/
     readonly StudioCMSPageFolderStructure: {
         readonly id: string;
         readonly name: string;
-        readonly parent: string | null | undefined;
+        readonly parent?: string | null | undefined;
     };
     readonly StudioCMSPageData: {
         readonly id: string;
@@ -56,25 +57,25 @@ declare const DBClientLive_base: Context.TagClass<DBClientLive, "@withstudiocms/
         readonly publishedAt: import("kysely").ColumnType<string, string, string>;
         readonly slug: string;
         readonly contentLang: string;
-        readonly heroImage: string | null | undefined;
         readonly categories: import("kysely").ColumnType<string, string, string>;
         readonly tags: import("kysely").ColumnType<string, string, string>;
         readonly authorId: string;
         readonly contributorIds: import("kysely").ColumnType<string, string, string>;
         readonly showAuthor: number;
         readonly showContributors: number;
-        readonly parentFolder: string | null | undefined;
         readonly draft: number;
         readonly augments: import("kysely").ColumnType<string, string, string>;
+        readonly heroImage?: string | null | undefined;
+        readonly parentFolder?: string | null | undefined;
     };
     readonly StudioCMSDiffTracking: {
         readonly id: string;
         readonly userId: string;
         readonly pageId: string;
-        readonly timestamp: import("kysely").ColumnType<string, string | undefined, never>;
+        readonly timestamp: import("kysely").ColumnType<string, string | undefined, undefined>;
         readonly pageMetaData: import("kysely").ColumnType<string, string, string>;
         readonly pageContentStart: string;
-        readonly diff: string | null | undefined;
+        readonly diff?: string | null | undefined;
     };
     readonly StudioCMSPageDataTags: {
         readonly id: number;
@@ -87,9 +88,9 @@ declare const DBClientLive_base: Context.TagClass<DBClientLive, "@withstudiocms/
         readonly id: number;
         readonly name: string;
         readonly description: string;
-        readonly parent: number | null | undefined;
         readonly slug: string;
         readonly meta: import("kysely").ColumnType<string, string, string>;
+        readonly parent?: number | null | undefined;
     };
     readonly StudioCMSPageContent: {
         readonly id: string;
@@ -111,6 +112,14 @@ declare const DBClientLive_base: Context.TagClass<DBClientLive, "@withstudiocms/
         readonly id: string;
         readonly data: import("kysely").ColumnType<string, string, string>;
     };
+    readonly StudioCMSStorageManagerUrlMappings: {
+        readonly url: string;
+        readonly updatedAt: number;
+        readonly createdAt: import("kysely").ColumnType<number, number | undefined, undefined>;
+        readonly identifier: string;
+        readonly isPermanent: import("kysely").ColumnType<number, boolean, boolean>;
+        readonly expiresAt?: number | null | undefined;
+    };
 }>>;
 /**
  * Context tag representing the database client interface for StudioCMS.
@@ -170,6 +179,7 @@ export interface SDKContext {
         store: Map<string, CacheEntry<unknown>>;
         tagIndex: Map<string, Set<string>>;
     };
+    storageManagerResolver: (identifier: string) => Promise<string>;
 }
 declare const CacheStores_base: Context.TagClass<CacheStores, "@withstudiocms/sdk/context/CacheStores", {
     store: Map<string, CacheEntry<unknown>>;
@@ -178,11 +188,21 @@ declare const CacheStores_base: Context.TagClass<CacheStores, "@withstudiocms/sd
 export declare class CacheStores extends CacheStores_base {
     static live: (cache: SDKContext["cache"]) => Layer.Layer<CacheStores, never, never>;
 }
+declare const StorageManagerResolver_base: Context.TagClass<StorageManagerResolver, "@withstudiocms/sdk/context/StorageManagerResolver", (identifier: string) => Promise<string>>;
+/**
+ * Context tag representing the storage manager resolver function.
+ *
+ * This tag can be used to access the function responsible for resolving storage manager URLs
+ * based on given identifiers.
+ */
+export declare class StorageManagerResolver extends StorageManagerResolver_base {
+    static live: (resolver: SDKContext["storageManagerResolver"]) => Layer.Layer<StorageManagerResolver, never, never>;
+}
 /**
  * Combines the database client and SDK default options into a single SDK context layer.
  *
  * @param context - An object containing the database client and default SDK options.
  * @returns A merged layer that provides both the DBClient and SDKDefaults context tags.
  */
-export declare const makeSDKContext: (context: SDKContext) => Layer.Layer<DBClientLive | SDKDefaults | CacheStores, never, never>;
+export declare const makeSDKContext: (context: SDKContext) => Layer.Layer<DBClientLive | SDKDefaults | CacheStores | StorageManagerResolver, never, never>;
 export {};

package/dist/context.js

@@ -20,14 +20,21 @@ class SDKDefaults extends Context.Tag("@withstudiocms/sdk/context/SDKDefaults")(
 class CacheStores extends Context.Tag("@withstudiocms/sdk/context/CacheStores")() {
   static live = (cache) => Layer.succeed(this, cache);
 }
+class StorageManagerResolver extends Context.Tag(
+  "@withstudiocms/sdk/context/StorageManagerResolver"
+)() {
+  static live = (resolver) => Layer.succeed(this, resolver);
+}
 const makeSDKContext = (context) => Layer.mergeAll(
   DBClientLive.Live(context.db),
   SDKDefaults.live(context.defaults),
-  CacheStores.live(context.cache)
+  CacheStores.live(context.cache),
+  StorageManagerResolver.live(context.storageManagerResolver)
 );
 export {
   CacheStores,
   DBClientLive,
   SDKDefaults,
+  StorageManagerResolver,
   makeSDKContext
 };

package/dist/errors.d.ts

@@ -0,0 +1,9 @@
+declare const StudioCMSSDKError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").Equals<A, {}> extends true ? void : { readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }) => import("effect/Cause").YieldableError & {
+    readonly _tag: "StudioCMSSDKError";
+} & Readonly<A>;
+export declare class StudioCMSSDKError extends StudioCMSSDKError_base<{
+    message: string;
+    cause?: unknown;
+}> {
+}
+export {};

package/dist/errors.js

@@ -0,0 +1,6 @@
+import { Data } from "@withstudiocms/effect";
+class StudioCMSSDKError extends Data.TaggedError("StudioCMSSDKError") {
+}
+export {
+  StudioCMSSDKError
+};