@studiocms/devapps 0.1.0-beta.8 → 0.1.0

package/dist/schema/wp-api.d.ts

@@ -1,439 +0,0 @@
-import { z } from 'astro/zod';
-/**
- * Schema definition for a WordPress Page object.
- *
- * This schema validates the structure of a WordPress Page object, ensuring that
- * all required fields are present and have the correct types.
- *
- * Properties:
- * - `id`: The unique identifier for the page (number).
- * - `date`: The date the page was created (Date).
- * - `date_gmt`: The date the page was created in GMT (Date).
- * - `guid`: The globally unique identifier for the page, containing a rendered string.
- * - `modified`: The date the page was last modified (Date).
- * - `modified_gmt`: The date the page was last modified in GMT (Date).
- * - `slug`: The URL-friendly slug for the page (string).
- * - `status`: The status of the page, which can be 'publish', 'future', 'draft', 'pending', or 'private'.
- * - `type`: The type of the page (string).
- * - `title`: The title of the page, containing a rendered string.
- * - `content`: The content of the page, containing a rendered string and a boolean indicating if it is protected.
- * - `excerpt`: The excerpt of the page, containing a rendered string and a boolean indicating if it is protected.
- * - `author`: The ID of the author of the page (number).
- * - `featured_media`: The ID of the featured media for the page (number).
- * - `parent`: The ID of the parent page (number).
- * - `menu_order`: The order of the page in the menu (number).
- * - `comment_status`: The comment status of the page, which can be 'open' or 'closed'.
- * - `ping_status`: The ping status of the page, which can be 'open' or 'closed'.
- * - `template`: The template used for the page (string).
- * - `meta`: An array of metadata associated with the page, which can be any type or a record of any type.
- */
-export declare const PageSchema: z.ZodObject<{
-    id: z.ZodNumber;
-    date: z.ZodDate;
-    date_gmt: z.ZodDate;
-    guid: z.ZodObject<{
-        rendered: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        rendered: string;
-    }, {
-        rendered: string;
-    }>;
-    modified: z.ZodDate;
-    modified_gmt: z.ZodDate;
-    slug: z.ZodString;
-    status: z.ZodEnum<["publish", "future", "draft", "pending", "private"]>;
-    type: z.ZodString;
-    title: z.ZodObject<{
-        rendered: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        rendered: string;
-    }, {
-        rendered: string;
-    }>;
-    content: z.ZodObject<{
-        rendered: z.ZodString;
-        protected: z.ZodBoolean;
-    }, "strip", z.ZodTypeAny, {
-        rendered: string;
-        protected: boolean;
-    }, {
-        rendered: string;
-        protected: boolean;
-    }>;
-    excerpt: z.ZodObject<{
-        rendered: z.ZodString;
-        protected: z.ZodBoolean;
-    }, "strip", z.ZodTypeAny, {
-        rendered: string;
-        protected: boolean;
-    }, {
-        rendered: string;
-        protected: boolean;
-    }>;
-    author: z.ZodNumber;
-    featured_media: z.ZodNumber;
-    parent: z.ZodNumber;
-    menu_order: z.ZodNumber;
-    comment_status: z.ZodEnum<["open", "closed", ""]>;
-    ping_status: z.ZodEnum<["open", "closed", ""]>;
-    template: z.ZodString;
-    meta: z.ZodArray<z.ZodUnion<[z.ZodAny, z.ZodRecord<z.ZodString, z.ZodAny>]>, "many">;
-}, "strip", z.ZodTypeAny, {
-    status: "publish" | "future" | "draft" | "pending" | "private";
-    type: string;
-    date: Date;
-    meta: any[];
-    template: string;
-    title: {
-        rendered: string;
-    };
-    content: {
-        rendered: string;
-        protected: boolean;
-    };
-    id: number;
-    date_gmt: Date;
-    guid: {
-        rendered: string;
-    };
-    modified: Date;
-    modified_gmt: Date;
-    slug: string;
-    excerpt: {
-        rendered: string;
-        protected: boolean;
-    };
-    author: number;
-    featured_media: number;
-    parent: number;
-    menu_order: number;
-    comment_status: "" | "open" | "closed";
-    ping_status: "" | "open" | "closed";
-}, {
-    status: "publish" | "future" | "draft" | "pending" | "private";
-    type: string;
-    date: Date;
-    meta: any[];
-    template: string;
-    title: {
-        rendered: string;
-    };
-    content: {
-        rendered: string;
-        protected: boolean;
-    };
-    id: number;
-    date_gmt: Date;
-    guid: {
-        rendered: string;
-    };
-    modified: Date;
-    modified_gmt: Date;
-    slug: string;
-    excerpt: {
-        rendered: string;
-        protected: boolean;
-    };
-    author: number;
-    featured_media: number;
-    parent: number;
-    menu_order: number;
-    comment_status: "" | "open" | "closed";
-    ping_status: "" | "open" | "closed";
-}>;
-/**
- * Extends the PageSchema to define the schema for a WordPress Post.
- *
- * Properties:
- * - `format`: Enum representing the format of the post. Possible values are:
- *   - 'standard'
- *   - 'aside'
- *   - 'chat'
- *   - 'gallery'
- *   - 'link'
- *   - 'image'
- *   - 'quote'
- *   - 'status'
- *   - 'video'
- *   - 'audio'
- *   - ''
- * - `categories`: Array of numbers representing the categories assigned to the post.
- * - `tags`: Array of numbers representing the tags assigned to the post.
- */
-export declare const PostSchema: z.ZodObject<z.objectUtil.extendShape<{
-    id: z.ZodNumber;
-    date: z.ZodDate;
-    date_gmt: z.ZodDate;
-    guid: z.ZodObject<{
-        rendered: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        rendered: string;
-    }, {
-        rendered: string;
-    }>;
-    modified: z.ZodDate;
-    modified_gmt: z.ZodDate;
-    slug: z.ZodString;
-    status: z.ZodEnum<["publish", "future", "draft", "pending", "private"]>;
-    type: z.ZodString;
-    title: z.ZodObject<{
-        rendered: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        rendered: string;
-    }, {
-        rendered: string;
-    }>;
-    content: z.ZodObject<{
-        rendered: z.ZodString;
-        protected: z.ZodBoolean;
-    }, "strip", z.ZodTypeAny, {
-        rendered: string;
-        protected: boolean;
-    }, {
-        rendered: string;
-        protected: boolean;
-    }>;
-    excerpt: z.ZodObject<{
-        rendered: z.ZodString;
-        protected: z.ZodBoolean;
-    }, "strip", z.ZodTypeAny, {
-        rendered: string;
-        protected: boolean;
-    }, {
-        rendered: string;
-        protected: boolean;
-    }>;
-    author: z.ZodNumber;
-    featured_media: z.ZodNumber;
-    parent: z.ZodNumber;
-    menu_order: z.ZodNumber;
-    comment_status: z.ZodEnum<["open", "closed", ""]>;
-    ping_status: z.ZodEnum<["open", "closed", ""]>;
-    template: z.ZodString;
-    meta: z.ZodArray<z.ZodUnion<[z.ZodAny, z.ZodRecord<z.ZodString, z.ZodAny>]>, "many">;
-}, {
-    format: z.ZodEnum<["standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio", ""]>;
-    categories: z.ZodArray<z.ZodNumber, "many">;
-    tags: z.ZodArray<z.ZodNumber, "many">;
-}>, "strip", z.ZodTypeAny, {
-    status: "publish" | "future" | "draft" | "pending" | "private";
-    type: string;
-    date: Date;
-    meta: any[];
-    template: string;
-    title: {
-        rendered: string;
-    };
-    content: {
-        rendered: string;
-        protected: boolean;
-    };
-    id: number;
-    date_gmt: Date;
-    guid: {
-        rendered: string;
-    };
-    modified: Date;
-    modified_gmt: Date;
-    slug: string;
-    excerpt: {
-        rendered: string;
-        protected: boolean;
-    };
-    author: number;
-    featured_media: number;
-    parent: number;
-    menu_order: number;
-    comment_status: "" | "open" | "closed";
-    ping_status: "" | "open" | "closed";
-    format: "" | "status" | "image" | "aside" | "audio" | "link" | "video" | "standard" | "chat" | "gallery" | "quote";
-    categories: number[];
-    tags: number[];
-}, {
-    status: "publish" | "future" | "draft" | "pending" | "private";
-    type: string;
-    date: Date;
-    meta: any[];
-    template: string;
-    title: {
-        rendered: string;
-    };
-    content: {
-        rendered: string;
-        protected: boolean;
-    };
-    id: number;
-    date_gmt: Date;
-    guid: {
-        rendered: string;
-    };
-    modified: Date;
-    modified_gmt: Date;
-    slug: string;
-    excerpt: {
-        rendered: string;
-        protected: boolean;
-    };
-    author: number;
-    featured_media: number;
-    parent: number;
-    menu_order: number;
-    comment_status: "" | "open" | "closed";
-    ping_status: "" | "open" | "closed";
-    format: "" | "status" | "image" | "aside" | "audio" | "link" | "video" | "standard" | "chat" | "gallery" | "quote";
-    categories: number[];
-    tags: number[];
-}>;
-/**
- * Schema for a WordPress Tag object.
- *
- * This schema validates the structure of a WordPress Tag object, ensuring that
- * it contains the following properties:
- *
- * - `id`: A numeric identifier for the tag.
- * - `count`: A numeric count of the number of posts associated with the tag.
- * - `description`: A string description of the tag.
- * - `link`: A URL string linking to the tag.
- * - `name`: A string name of the tag.
- * - `slug`: A string slug for the tag.
- * - `taxonomy`: A string representing the taxonomy type.
- * - `meta`: An array or record of any additional metadata associated with the tag.
- */
-export declare const TagSchema: z.ZodObject<{
-    id: z.ZodNumber;
-    count: z.ZodNumber;
-    description: z.ZodString;
-    link: z.ZodString;
-    name: z.ZodString;
-    slug: z.ZodString;
-    taxonomy: z.ZodString;
-    meta: z.ZodUnion<[z.ZodArray<z.ZodAny, "many">, z.ZodRecord<z.ZodString, z.ZodAny>]>;
-}, "strip", z.ZodTypeAny, {
-    link: string;
-    meta: any[] | Record<string, any>;
-    id: number;
-    slug: string;
-    count: number;
-    description: string;
-    name: string;
-    taxonomy: string;
-}, {
-    link: string;
-    meta: any[] | Record<string, any>;
-    id: number;
-    slug: string;
-    count: number;
-    description: string;
-    name: string;
-    taxonomy: string;
-}>;
-/**
- * Extends the TagSchema to create a CategorySchema.
- *
- * @property {number} parent - The ID of the parent category.
- */
-export declare const CategorySchema: z.ZodObject<z.objectUtil.extendShape<{
-    id: z.ZodNumber;
-    count: z.ZodNumber;
-    description: z.ZodString;
-    link: z.ZodString;
-    name: z.ZodString;
-    slug: z.ZodString;
-    taxonomy: z.ZodString;
-    meta: z.ZodUnion<[z.ZodArray<z.ZodAny, "many">, z.ZodRecord<z.ZodString, z.ZodAny>]>;
-}, {
-    parent: z.ZodNumber;
-}>, "strip", z.ZodTypeAny, {
-    link: string;
-    meta: any[] | Record<string, any>;
-    id: number;
-    slug: string;
-    parent: number;
-    count: number;
-    description: string;
-    name: string;
-    taxonomy: string;
-}, {
-    link: string;
-    meta: any[] | Record<string, any>;
-    id: number;
-    slug: string;
-    parent: number;
-    count: number;
-    description: string;
-    name: string;
-    taxonomy: string;
-}>;
-/**
- * Schema for site settings in the WordPress API.
- *
- * This schema defines the structure of the site settings object, which includes
- * various properties related to the site's configuration.
- *
- * Properties:
- * - `name`: The name of the site (string).
- * - `description`: A brief description of the site (string).
- * - `url`: The URL of the site (string).
- * - `home`: The home URL of the site (string).
- * - `gmt_offset`: The GMT offset for the site's timezone (number).
- * - `timezone_string`: The timezone string for the site (string).
- * - `site_logo`: The ID of the site's logo (optional number).
- * - `site_icon`: The ID of the site's icon (optional number).
- * - `site_icon_url`: The URL of the site's icon (optional string).
- */
-export declare const SiteSettingsSchema: z.ZodObject<{
-    name: z.ZodString;
-    description: z.ZodString;
-    url: z.ZodString;
-    home: z.ZodString;
-    gmt_offset: z.ZodNumber;
-    timezone_string: z.ZodString;
-    site_logo: z.ZodOptional<z.ZodNumber>;
-    site_icon: z.ZodOptional<z.ZodNumber>;
-    site_icon_url: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    url: string;
-    description: string;
-    name: string;
-    home: string;
-    gmt_offset: number;
-    timezone_string: string;
-    site_logo?: number | undefined;
-    site_icon?: number | undefined;
-    site_icon_url?: string | undefined;
-}, {
-    url: string;
-    description: string;
-    name: string;
-    home: string;
-    gmt_offset: number;
-    timezone_string: string;
-    site_logo?: number | undefined;
-    site_icon?: number | undefined;
-    site_icon_url?: string | undefined;
-}>;
-/**
- * Represents the type of a Page object as defined by the PageSchema.
- * This type is derived from the output type of the PageSchema.
- */
-export type Page = z.infer<typeof PageSchema>;
-/**
- * Represents a WordPress post based on the PostSchema.
- *
- * This type is derived from the output type of the PostSchema.
- */
-export type Post = z.infer<typeof PostSchema>;
-/**
- * Represents a Tag type derived from the TagSchema's output type.
- */
-export type Tag = z.infer<typeof TagSchema>;
-/**
- * Represents a Category type derived from the output of the CategorySchema.
- */
-export type Category = z.infer<typeof CategorySchema>;
-/**
- * Represents the settings for a site.
- *
- * This type is derived from the output of the `SiteSettingsSchema`.
- */
-export type SiteSettings = z.infer<typeof SiteSettingsSchema>;

package/dist/schema/wp-api.js

@@ -1,72 +0,0 @@
-import { z } from "astro/zod";
-const OpenClosedSchema = z.enum(["open", "closed", ""]);
-const PageSchema = z.object({
-  id: z.number(),
-  date: z.coerce.date(),
-  date_gmt: z.coerce.date(),
-  guid: z.object({ rendered: z.string() }),
-  modified: z.coerce.date(),
-  modified_gmt: z.coerce.date(),
-  slug: z.string(),
-  status: z.enum(["publish", "future", "draft", "pending", "private"]),
-  type: z.string(),
-  title: z.object({ rendered: z.string() }),
-  content: z.object({ rendered: z.string(), protected: z.boolean() }),
-  excerpt: z.object({ rendered: z.string(), protected: z.boolean() }),
-  author: z.number(),
-  featured_media: z.number(),
-  parent: z.number(),
-  menu_order: z.number(),
-  comment_status: OpenClosedSchema,
-  ping_status: OpenClosedSchema,
-  template: z.string(),
-  meta: z.array(z.any().or(z.record(z.any())))
-});
-const PostSchema = PageSchema.extend({
-  format: z.enum([
-    "standard",
-    "aside",
-    "chat",
-    "gallery",
-    "link",
-    "image",
-    "quote",
-    "status",
-    "video",
-    "audio",
-    ""
-  ]),
-  categories: z.array(z.number()),
-  tags: z.array(z.number())
-});
-const TagSchema = z.object({
-  id: z.number(),
-  count: z.number(),
-  description: z.string(),
-  link: z.string().url(),
-  name: z.string(),
-  slug: z.string(),
-  taxonomy: z.string(),
-  meta: z.array(z.any()).or(z.record(z.any()))
-});
-const CategorySchema = TagSchema.extend({
-  parent: z.number()
-});
-const SiteSettingsSchema = z.object({
-  name: z.string(),
-  description: z.string(),
-  url: z.string(),
-  home: z.string(),
-  gmt_offset: z.coerce.number(),
-  timezone_string: z.string(),
-  site_logo: z.number().optional(),
-  site_icon: z.number().optional(),
-  site_icon_url: z.string().optional()
-});
-export {
-  CategorySchema,
-  PageSchema,
-  PostSchema,
-  SiteSettingsSchema,
-  TagSchema
-};

package/dist/utils/wp-api/converters.d.ts

@@ -1,74 +0,0 @@
-import type { PageContent, PageData } from './index.js';
-/**
- * Converts a given page object to a PageData object.
- *
- * @param page - The page object to convert. This is expected to be of an unknown type.
- * @param endpoint - The API endpoint to fetch additional data, such as media.
- * @returns A promise that resolves to a PageData object containing the converted page data.
- *
- * @throws Will throw an error if fetching the title image fails.
- */
-export declare const ConvertToPageData: (page: unknown, endpoint: string) => Promise<PageData>;
-/**
- * Converts the provided page data and page content into a PageContent object.
- *
- * @param pageData - The data of the page to be converted.
- * @param page - The raw page content to be converted.
- * @returns A promise that resolves to a PageContent object.
- * @throws Will throw an error if the pageData is missing an id.
- */
-export declare const ConvertToPageContent: (pageData: PageData, page: unknown) => Promise<PageContent>;
-/**
- * Generates and inserts categories into the database if they do not already exist.
- *
- * @param categories - An array of category IDs to be processed.
- * @param endpoint - The API endpoint to fetch category data from.
- * @returns A promise that resolves when the categories have been processed and inserted into the database.
- *
- * This function performs the following steps:
- * 1. Iterates over the provided category IDs.
- * 2. Checks if each category already exists in the database.
- * 3. If a category does not exist, fetches the category data from the specified API endpoint.
- * 4. Collects the new category data.
- * 5. Maps the new category data to the database schema.
- * 6. Inserts the new categories into the database.
- */
-export declare const generateCategories: (categories: number[], endpoint: string) => Promise<void>;
-/**
- * Generates and inserts tags into the database if they do not already exist.
- *
- * @param {number[]} tags - An array of tag IDs to be processed.
- * @param {string} endpoint - The API endpoint to fetch tag data from.
- * @returns {Promise<void>} A promise that resolves when the operation is complete.
- *
- * @example
- * const tags = [1, 2, 3];
- * const endpoint = 'https://example.com/wp-json/wp/v2';
- * await generateTags(tags, endpoint);
- *
- * @remarks
- * This function checks if each tag ID already exists in the database. If a tag does not exist,
- * it fetches the tag data from the specified API endpoint and inserts it into the database.
- * The function logs messages to the console for each tag that is processed.
- */
-export declare const generateTags: (tags: number[], endpoint: string) => Promise<void>;
-/**
- * Converts a given post object to PageData format.
- *
- * @param post - The post object to be converted.
- * @param useBlogPkg - A boolean indicating whether to use the blog package.
- * @param endpoint - The API endpoint to fetch additional data.
- * @returns A promise that resolves to the converted PageData object.
- *
- * @throws Will throw an error if fetching the title image or downloading the post image fails.
- */
-export declare const ConvertToPostData: (post: unknown, useBlogPkg: boolean, endpoint: string) => Promise<PageData>;
-/**
- * Converts the given post data to a PageContent object.
- *
- * @param pageData - The data of the page to which the post content belongs.
- * @param post - The post data to be converted.
- * @returns A promise that resolves to a PageContent object.
- * @throws Will throw an error if the pageData is missing an id.
- */
-export declare const ConvertToPostContent: (pageData: PageData, post: unknown) => Promise<PageContent>;