@studiocms/devapps 0.2.1 → 0.3.0

package/dist/effects/WordPressAPI/converters.d.ts

@@ -8,12 +8,12 @@ declare const WordPressAPIConverters_base: Effect.Service.Class<WordPressAPIConv
     readonly effect: Effect.Effect<{
         convertToPageData: Effect.Effect<{
             readonly title: string;
+            readonly description: string;
             readonly draft: boolean;
             readonly id: string;
             readonly slug: string;
             readonly categories: string;
             readonly tags: string;
-            readonly description: string;
             readonly package: string;
             readonly showOnNav: boolean;
             readonly publishedAt: string;
@@ -30,12 +30,12 @@ declare const WordPressAPIConverters_base: Effect.Service.Class<WordPressAPIConv
         convertToPageContent: Effect.Effect<CombinedInsertContent, boolean | WPAPIError | import("effect/ConfigError").ConfigError | import("astro/errors").AstroError | import("effect/Cause").UnknownException | import("effect/ParseResult").ParseError, RawPageData | FullPageData>;
         convertToPostData: Effect.Effect<{
             readonly title: string;
+            readonly description: string;
             readonly draft: boolean;
             readonly id: string;
             readonly slug: string;
             readonly categories: string;
             readonly tags: string;
-            readonly description: string;
             readonly package: string;
             readonly showOnNav: boolean;
             readonly publishedAt: string;

package/dist/effects/WordPressAPI/importers.d.ts

@@ -9,8 +9,8 @@ declare const WordPressAPI_base: Effect.Service.Class<WordPressAPI, "WordPressAP
     readonly dependencies: readonly [import("effect/Layer").Layer<WordPressAPIUtils, never, never>, import("effect/Layer").Layer<WordPressAPIConverters, import("effect/ConfigError").ConfigError | import("studiocms/sdk/base").DBClientInitializationError | import("studiocms/sdk/base").SDKInitializationError, never>];
     readonly effect: Effect.Effect<{
         importSettingsFromWPAPI: Effect.Effect<void, boolean | import("effect/ConfigError").ConfigError | import("astro/errors").AstroError | import("effect/Cause").UnknownException | import("effect/ParseResult").ParseError | import("@withstudiocms/kysely/client").DBCallbackFailure | import("@withstudiocms/kysely/core/errors").DatabaseError, ImportEndpointConfig>;
-        importPagesFromWPAPI: Effect.Effect<void, boolean | import("./errors.js").WPAPIError | import("effect/ConfigError").ConfigError | import("astro/errors").AstroError | import("effect/Cause").UnknownException | import("effect/ParseResult").ParseError | import("@withstudiocms/kysely/client").DBCallbackFailure | import("@withstudiocms/kysely/core/errors").DatabaseError, ImportEndpointConfig>;
-        importPostsFromWPAPI: Effect.Effect<void, boolean | import("./errors.js").WPAPIError | import("effect/ConfigError").ConfigError | import("astro/errors").AstroError | import("effect/Cause").UnknownException | import("effect/ParseResult").ParseError | import("@withstudiocms/kysely/client").DBCallbackFailure | import("@withstudiocms/kysely/core/errors").DatabaseError, ImportPostsEndpointConfig>;
+        importPagesFromWPAPI: Effect.Effect<void, boolean | import("./errors.ts").WPAPIError | import("effect/ConfigError").ConfigError | import("astro/errors").AstroError | import("effect/Cause").UnknownException | import("effect/ParseResult").ParseError | import("@withstudiocms/kysely/client").DBCallbackFailure | import("@withstudiocms/kysely/core/errors").DatabaseError, ImportEndpointConfig>;
+        importPostsFromWPAPI: Effect.Effect<void, boolean | import("./errors.ts").WPAPIError | import("effect/ConfigError").ConfigError | import("astro/errors").AstroError | import("effect/Cause").UnknownException | import("effect/ParseResult").ParseError | import("@withstudiocms/kysely/client").DBCallbackFailure | import("@withstudiocms/kysely/core/errors").DatabaseError, ImportPostsEndpointConfig>;
     }, import("effect/ConfigError").ConfigError | import("studiocms/sdk/base").DBClientInitializationError | import("studiocms/sdk/base").SDKInitializationError, WordPressAPIUtils | WordPressAPIConverters>;
 }>;
 export declare class WordPressAPI extends WordPressAPI_base {

package/dist/effects/WordPressAPI/schema.d.ts

@@ -74,21 +74,21 @@ declare const Page_base: Schema.Class<Page, {
     template: typeof Schema.String;
     meta: Schema.Array$<Schema.Union<[typeof Schema.Any, Schema.Record$<typeof Schema.String, typeof Schema.Any>]>>;
 }>, never, {
-    readonly status: "publish" | "future" | "draft" | "pending" | "private";
-} & {
-    readonly type: string;
-} & {
-    readonly date: Date;
+    readonly title: {
+        readonly rendered: string;
+    };
 } & {
     readonly meta: readonly any[];
 } & {
     readonly template: string;
 } & {
-    readonly title: {
-        readonly rendered: string;
-    };
+    readonly type: string;
+} & {
+    readonly status: "publish" | "future" | "draft" | "pending" | "private";
 } & {
     readonly id: number;
+} & {
+    readonly date: Date;
 } & {
     readonly date_gmt: Date;
 } & {
@@ -232,21 +232,21 @@ declare const Post_base: Schema.Class<Post, {
     template: typeof Schema.String;
     meta: Schema.Array$<Schema.Union<[typeof Schema.Any, Schema.Record$<typeof Schema.String, typeof Schema.Any>]>>;
 }>, never, {
-    readonly status: "publish" | "future" | "draft" | "pending" | "private";
-} & {
-    readonly type: string;
-} & {
-    readonly date: Date;
+    readonly title: {
+        readonly rendered: string;
+    };
 } & {
     readonly meta: readonly any[];
 } & {
     readonly template: string;
 } & {
-    readonly title: {
-        readonly rendered: string;
-    };
+    readonly type: string;
+} & {
+    readonly status: "publish" | "future" | "draft" | "pending" | "private";
 } & {
     readonly id: number;
+} & {
+    readonly date: Date;
 } & {
     readonly date_gmt: Date;
 } & {
@@ -282,7 +282,7 @@ declare const Post_base: Schema.Class<Post, {
 } & {
     readonly ping_status: "" | "open" | "closed";
 } & {
-    readonly format: "" | "status" | "image" | "aside" | "audio" | "link" | "video" | "standard" | "chat" | "gallery" | "quote";
+    readonly format: "" | "image" | "aside" | "audio" | "link" | "video" | "standard" | "chat" | "gallery" | "quote" | "status";
 } & {
     readonly categories: readonly number[];
 } & {
@@ -337,6 +337,8 @@ declare const Tag_base: Schema.Class<Tag, {
     taxonomy: typeof Schema.String;
     meta: Schema.Array$<Schema.Union<[typeof Schema.Any, Schema.Record$<typeof Schema.String, typeof Schema.Any>]>>;
 }>, never, {
+    readonly description: string;
+} & {
     readonly link: string;
 } & {
     readonly meta: readonly any[];
@@ -346,8 +348,6 @@ declare const Tag_base: Schema.Class<Tag, {
     readonly slug: string;
 } & {
     readonly count: number;
-} & {
-    readonly description: string;
 } & {
     readonly name: string;
 } & {
@@ -400,6 +400,8 @@ declare const Category_base: Schema.Class<Category, {
     taxonomy: typeof Schema.String;
     meta: Schema.Array$<Schema.Union<[typeof Schema.Any, Schema.Record$<typeof Schema.String, typeof Schema.Any>]>>;
 }>, never, {
+    readonly description: string;
+} & {
     readonly link: string;
 } & {
     readonly meta: readonly any[];
@@ -411,8 +413,6 @@ declare const Category_base: Schema.Class<Category, {
     readonly parent: number;
 } & {
     readonly count: number;
-} & {
-    readonly description: string;
 } & {
     readonly name: string;
 } & {
@@ -455,9 +455,9 @@ declare const SiteSettings_base: Schema.Class<SiteSettings, {
     site_icon: Schema.optional<typeof Schema.Number>;
     site_icon_url: Schema.optional<typeof Schema.String>;
 }>, never, {
-    readonly url: string;
-} & {
     readonly description: string;
+} & {
+    readonly url: string;
 } & {
     readonly name: string;
 } & {

package/dist/index.js

@@ -1,8 +1,9 @@
 import { addVirtualImports, createResolver, injectDevRoute } from "astro-integration-kit";
+import { Schema } from "effect";
 import { StudioCMSDevAppsSchema } from "./schema/index.js";
 import { pathGenerator } from "./utils/pathGenerator.js";
-function studioCMSDevApps(opts) {
-  const options = StudioCMSDevAppsSchema.parse(opts);
+function studioCMSDevApps(opts = {}) {
+  const options = Schema.decodeSync(StudioCMSDevAppsSchema)(opts);
   const { resolve } = createResolver(import.meta.url);
   let makeEndpointPath;
   return {

package/dist/schema/index.d.ts

@@ -1,128 +1,78 @@
-import { z } from 'astro/zod';
+import { Schema } from 'effect';
 /**
- * Schema for the configuration of StudioCMS development applications.
- *
- * This schema defines the configuration options for the following applications:
- *
- * - **Astro DB LibSQL Viewer App**: Controlled by the `libSQLViewer` property.
- * - **StudioCMS WP API Importer App**: Controlled by the `wpImporter` property.
- *
- * The schema provides default values and transformation logic to ensure the configuration
- * is in the expected format.
- *
- * @property libSQLViewer - Configuration for the Astro DB LibSQL Viewer App.
- * - `boolean` - Indicates whether the app is enabled. Defaults to `true`.
- *
- * @property wpImporter - Configuration for the StudioCMS WP API Importer App.
- * - `boolean` - Indicates whether the app is enabled.
- * - `object` - Contains additional configuration options:
- *   - `endpoint` - The API endpoint for the importer. Defaults to `'wp-api-importer'`.
- *
- * @returns An object with the transformed configuration:
- * - `libSQLViewer` - An object with an `enabled` property indicating the app's status.
- * - `wpImporter` - An object with `enabled` and `endpoint` properties for the app's configuration.
+ * Represents the input configuration for the WP Importer application within StudioCMS.
  */
-export declare const AppsConfigSchema: z.ZodEffects<z.ZodDefault<z.ZodOptional<z.ZodObject<{
-    /**
-     * StudioCMS WP API Importer App Config
-     */
-    wpImporter: z.ZodUnion<[z.ZodBoolean, z.ZodObject<{
-        endpoint: z.ZodDefault<z.ZodOptional<z.ZodString>>;
-    }, "strip", z.ZodTypeAny, {
-        endpoint: string;
-    }, {
-        endpoint?: string | undefined;
-    }>]>;
-}, "strip", z.ZodTypeAny, {
-    wpImporter: boolean | {
-        endpoint: string;
-    };
-}, {
-    wpImporter: boolean | {
-        endpoint?: string | undefined;
-    };
-}>>>, {
-    wpImporter: {
-        enabled: boolean;
-        endpoint: string;
-    };
-}, {
-    wpImporter: boolean | {
-        endpoint?: string | undefined;
-    };
-} | undefined>;
+export declare const WPImporterInputSchema: Schema.Union<[typeof Schema.Boolean, Schema.Struct<{
+    endpoint: typeof Schema.String;
+}>]>;
 /**
- * Schema definition for StudioCMS development applications configuration.
- *
- * This schema defines the structure of the configuration object for StudioCMS
- * development applications. It includes the following properties:
- *
- * - `endpoint` (optional): A string representing the endpoint for the dev apps.
- *   Defaults to '_studiocms-devapps'.
- * - `verbose` (optional): A boolean indicating whether verbose logging is enabled.
- *   Defaults to `false`.
- * - `appsConfig`: The configuration schema for the applications.
- *
- * The entire schema is optional and defaults to an empty object if not provided.
+ * Represents the configuration for the WP Importer application within StudioCMS.
  */
-export declare const StudioCMSDevAppsSchema: z.ZodDefault<z.ZodOptional<z.ZodObject<{
-    endpoint: z.ZodDefault<z.ZodOptional<z.ZodString>>;
-    verbose: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-    appsConfig: z.ZodEffects<z.ZodDefault<z.ZodOptional<z.ZodObject<{
-        /**
-         * StudioCMS WP API Importer App Config
-         */
-        wpImporter: z.ZodUnion<[z.ZodBoolean, z.ZodObject<{
-            endpoint: z.ZodDefault<z.ZodOptional<z.ZodString>>;
-        }, "strip", z.ZodTypeAny, {
-            endpoint: string;
-        }, {
-            endpoint?: string | undefined;
-        }>]>;
-    }, "strip", z.ZodTypeAny, {
-        wpImporter: boolean | {
-            endpoint: string;
-        };
-    }, {
-        wpImporter: boolean | {
-            endpoint?: string | undefined;
-        };
-    }>>>, {
-        wpImporter: {
-            enabled: boolean;
-            endpoint: string;
-        };
-    }, {
-        wpImporter: boolean | {
-            endpoint?: string | undefined;
-        };
-    } | undefined>;
-}, "strip", z.ZodTypeAny, {
-    endpoint: string;
-    verbose: boolean;
-    appsConfig: {
-        wpImporter: {
+export declare const WPImporterOutputSchema: Schema.Struct<{
+    enabled: typeof Schema.Boolean;
+    endpoint: typeof Schema.String;
+}>;
+/**
+ * A schema for validating the configuration of the WP Importer application within StudioCMS.
+ */
+export declare const WPImporterSchema: Schema.transformOrFail<Schema.Union<[typeof Schema.Boolean, Schema.Struct<{
+    endpoint: typeof Schema.String;
+}>]>, Schema.Struct<{
+    enabled: typeof Schema.Boolean;
+    endpoint: typeof Schema.String;
+}>, never>;
+/**
+ * Represents the configuration for the WP Importer application within StudioCMS.
+ */
+export declare const AppsConfigSchema: Schema.Struct<{
+    wpImporter: Schema.optionalWith<Schema.transformOrFail<Schema.Union<[typeof Schema.Boolean, Schema.Struct<{
+        endpoint: typeof Schema.String;
+    }>]>, Schema.Struct<{
+        enabled: typeof Schema.Boolean;
+        endpoint: typeof Schema.String;
+    }>, never>, {
+        default: () => {
             enabled: boolean;
             endpoint: string;
         };
-    };
-}, {
-    endpoint?: string | undefined;
-    verbose?: boolean | undefined;
-    appsConfig?: {
-        wpImporter: boolean | {
-            endpoint?: string | undefined;
+    }>;
+}>;
+/**
+ * Represents the configuration for StudioCMS development applications.
+ */
+export declare const StudioCMSDevAppsSchema: Schema.Struct<{
+    endpoint: Schema.optionalWith<typeof Schema.String, {
+        default: () => string;
+    }>;
+    verbose: Schema.optionalWith<typeof Schema.Boolean, {
+        default: () => false;
+    }>;
+    appsConfig: Schema.optionalWith<Schema.Struct<{
+        wpImporter: Schema.optionalWith<Schema.transformOrFail<Schema.Union<[typeof Schema.Boolean, Schema.Struct<{
+            endpoint: typeof Schema.String;
+        }>]>, Schema.Struct<{
+            enabled: typeof Schema.Boolean;
+            endpoint: typeof Schema.String;
+        }>, never>, {
+            default: () => {
+                enabled: boolean;
+                endpoint: string;
+            };
+        }>;
+    }>, {
+        default: () => {
+            readonly wpImporter: {
+                readonly endpoint: string;
+                readonly enabled: boolean;
+            };
         };
-    } | undefined;
-}>>>;
+    }>;
+}>;
 /**
- * Represents the options for StudioCMS development applications.
- *
- * This type is derived from the `_input` property of the `StudioCMSDevAppsSchema` object.
+ * Represents the input configuration for StudioCMS development applications.
  */
-export type StudioCMSDevAppsOptions = typeof StudioCMSDevAppsSchema._input;
+export type StudioCMSDevAppsOptions = typeof StudioCMSDevAppsSchema.Encoded;
 /**
- * Represents the configuration type for StudioCMS development applications.
- * This type is derived from the output of the `StudioCMSDevAppsSchema`.
+ * Represents the fully parsed configuration for StudioCMS development applications.
  */
-export type StudioCMSDevAppsConfig = z.infer<typeof StudioCMSDevAppsSchema>;
+export type StudioCMSDevAppsConfig = typeof StudioCMSDevAppsSchema.Type;

package/dist/schema/index.js

@@ -1,33 +1,110 @@
-import { z } from "astro/zod";
-const AppsConfigSchema = z.object({
-  /**
-   * StudioCMS WP API Importer App Config
-   */
-  wpImporter: z.union([
-    z.boolean(),
-    z.object({
-      endpoint: z.string().optional().default("wp-api-importer")
-    })
-  ])
-}).optional().default({
-  wpImporter: { endpoint: "wp-api-importer" }
-}).transform((val) => {
-  let wpAPI;
-  if (typeof val.wpImporter === "boolean") {
-    wpAPI = { enabled: val.wpImporter, endpoint: "wp-api-importer" };
-  } else {
-    wpAPI = { enabled: true, endpoint: val.wpImporter.endpoint };
+import { ParseResult, Schema } from "effect";
+const WPImporterInputSchema = Schema.Union(
+  Schema.Boolean,
+  Schema.Struct({
+    endpoint: Schema.String
+  })
+).annotations({
+  title: "WP Importer Input Configuration",
+  identifier: "WPImporterInputConfig",
+  description: "The input configuration for the StudioCMS WP API Importer App. Can be a boolean to enable/disable or an object to specify the endpoint."
+});
+const WPImporterOutputSchema = Schema.Struct({
+  enabled: Schema.Boolean,
+  endpoint: Schema.String
+}).annotations({
+  title: "WP Importer Output Configuration",
+  identifier: "WPImporterOutputConfig",
+  description: "The output configuration for the StudioCMS WP API Importer App, including enabled status and endpoint."
+});
+const wpImporterDefaults = {
+  enabled: true,
+  endpoint: "wp-api-importer"
+};
+const WPImporterSchema = Schema.transformOrFail(
+  WPImporterInputSchema,
+  WPImporterOutputSchema,
+  {
+    strict: true,
+    decode: (input, _options, ast) => {
+      if (typeof input !== "boolean" && typeof input !== "object") {
+        return ParseResult.fail(
+          new ParseResult.Type(
+            ast,
+            input,
+            "Expected boolean or object for WP Importer configuration"
+          )
+        );
+      }
+      if (typeof input === "boolean") {
+        return ParseResult.succeed({
+          ...wpImporterDefaults,
+          enabled: input
+        });
+      }
+      if (typeof input === "object" && typeof input.endpoint === "string") {
+        return ParseResult.succeed({
+          ...wpImporterDefaults,
+          endpoint: input.endpoint
+        });
+      }
+      return ParseResult.fail(
+        new ParseResult.Type(ast, input, "Invalid type for WP Importer configuration")
+      );
+    },
+    encode: (input) => {
+      if (input.enabled === false) {
+        return ParseResult.succeed(false);
+      }
+      if (input.endpoint !== wpImporterDefaults.endpoint) {
+        return ParseResult.succeed({
+          endpoint: input.endpoint
+        });
+      }
+      return ParseResult.succeed(true);
+    }
   }
-  return {
-    wpImporter: wpAPI
-  };
+).annotations({
+  title: "WP Importer Configuration",
+  identifier: "WPImporterConfig",
+  description: "Configuration for the StudioCMS WP API Importer App. Can be a boolean to enable/disable or a string to specify the endpoint."
+});
+const AppsConfigSchema = Schema.Struct({
+  wpImporter: Schema.optionalWith(WPImporterSchema, {
+    default: () => wpImporterDefaults
+  }).annotations({
+    description: "Configuration for the StudioCMS WP API Importer App. Can be a boolean to enable/disable or a string to specify the endpoint."
+  })
+}).annotations({
+  title: "StudioCMS Apps Configuration",
+  identifier: "StudioCMSAppsConfig",
+  description: "Configuration for the StudioCMS development applications."
+});
+const StudioCMSDevAppsSchema = Schema.Struct({
+  endpoint: Schema.optionalWith(Schema.String, {
+    default: () => "_studiocms-devapps"
+  }).annotations({
+    description: "The endpoint for the StudioCMS development applications."
+  }),
+  verbose: Schema.optionalWith(Schema.Boolean, {
+    default: () => false
+  }).annotations({
+    description: "Enable verbose logging for StudioCMS development applications."
+  }),
+  appsConfig: Schema.optionalWith(AppsConfigSchema, {
+    default: () => AppsConfigSchema.make({})
+  }).annotations({
+    description: "Configuration for the StudioCMS development applications."
+  })
+}).annotations({
+  title: "StudioCMS DevApps Configuration",
+  identifier: "StudioCMSDevAppsConfig",
+  description: "Configuration schema for StudioCMS development applications, including endpoint settings and individual app configurations."
 });
-const StudioCMSDevAppsSchema = z.object({
-  endpoint: z.string().optional().default("_studiocms-devapps"),
-  verbose: z.boolean().optional().default(false),
-  appsConfig: AppsConfigSchema
-}).optional().default({});
 export {
   AppsConfigSchema,
-  StudioCMSDevAppsSchema
+  StudioCMSDevAppsSchema,
+  WPImporterInputSchema,
+  WPImporterOutputSchema,
+  WPImporterSchema
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@studiocms/devapps",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Devapps for StudioCMS Astro projects, including a WordPress importer.",
   "author": {
     "name": "withstudiocms",
@@ -51,7 +51,7 @@
     "astro-integration-kit": "^0.19.1",
     "cheerio": "^1.2.0",
     "turndown": "^7.2.2",
-    "sanitize-html": "^2.17.0"
+    "sanitize-html": "^2.17.1"
   },
   "devDependencies": {
     "@types/turndown": "^5.0.6",
@@ -59,11 +59,11 @@
     "astro": "^5.12.9",
     "typescript": "^5.9.3",
     "vite": "^6.3.4",
-    "@withstudiocms/sdk": "^0.2.0",
-    "studiocms": "^0.3.0"
+    "@withstudiocms/sdk": "^0.3.0",
+    "studiocms": "^0.4.0"
   },
   "peerDependencies": {
-    "effect": "^3.19.15"
+    "effect": "^3.19.19"
   },
   "scripts": {
     "build": "buildkit build 'src/**/*.{ts,astro,css,json,png,d.ts}'",