simple-strapi 1.0.0-alpha.3 → 1.0.0-alpha.4

package/dist/client.d.ts

@@ -1,7 +1,9 @@
 import { InferNumber, NumberField, NumberOptions } from "./fields/number";
 import { InferText, TextField, TextOptions } from "./fields/text";
 import { InferRelationHasMany, InferRelationHasOne, RelationHasManyField, RelationHasManyOptions, RelationHasOneField, RelationHasOneOptions } from "./fields/relation";
+import z from "zod";
 import { DynamicField, DynamicOptions, InferDynamic } from "./fields/dynamic";
+import { defaultStrapiFieldsSchema } from "./utils/schema";
 import { ComponentRepeatableField, ComponentRepeatableOptions, ComponentSingleField, ComponentSingleOptions, InferComponentRepeatable, InferComponentSingle } from "./fields/component";
 import { InferMediaSingle, MediaSingleField, MediaSingleOptions } from "./fields/media";
 import { EnumerationField, EnumerationOptions, InferEnumeration } from "./fields/enumeration";
@@ -40,6 +42,7 @@ export type InferSchema<S extends Schema> = {
         infer O extends EnumerationOptions
     ] ? InferEnumeration<V, O> : S[K] extends ["richText.blocks", infer O extends RichTextBlocksOptions] ? InferRichTextBlocks<O> : never;
 };
+export type InferSchemaWithDefaults<S extends Schema> = InferSchema<S> & z.output<typeof defaultStrapiFieldsSchema>;
 declare class Client {
     private options;
     private static headers;
@@ -73,7 +76,7 @@ declare class Client {
         schema: S;
         populate?: any;
     }>): Promise<{
-        data: InferSchema<S>;
+        data: InferSchemaWithDefaults<S>;
         meta: any;
     }>;
     getSingle(pluralID: string, options: EntityRequest<{
@@ -90,7 +93,7 @@ declare class Client {
         };
         populate?: any;
     }>): Promise<{
-        data: InferSchema<S>[];
+        data: InferSchemaWithDefaults<S>[];
         meta: any;
     }>;
     getCollection(pluralID: string, options: EntityRequest<{

package/dist/client.js

@@ -3,7 +3,7 @@ import { join } from "path";
 import fetch from "node-fetch";
 import qs from "qs";
 import z from "zod";
-import { schemaToParser } from "./utils/schema";
+import { defaultStrapiFields, schemaToParser } from "./utils/schema";
 class Client {
     static async create(endpoint, { auth, ...options } = {}) {
         const endpointURL = new URL(endpoint);
@@ -177,7 +177,7 @@ class Client {
             if ("schema" in options) {
                 const { schema: shape } = options;
                 if (shape) {
-                    const schema = z.object(schemaToParser(shape)).loose();
+                    const schema = z.object(schemaToParser(shape)).extend(defaultStrapiFields).loose();
                     const result = schema.safeParse(data);
                     if (!result.success) {
                         console.warn("⚠️ Single entity parsing error");
@@ -247,7 +247,7 @@ class Client {
             if ("schema" in options) {
                 const { schema: shape } = options;
                 if (shape) {
-                    const schema = z.object(schemaToParser(shape)).loose();
+                    const schema = z.object(schemaToParser(shape)).extend(defaultStrapiFields).loose();
                     const parsedData = [];
                     for (const entry of data) {
                         const result = schema.safeParse(entry);

package/dist/fields/component.d.ts

@@ -1,12 +1,12 @@
 import { ZodType } from "zod";
-import { InferSchema, Schema } from "../client";
+import { InferSchemaWithDefaults, Schema } from "../client";
 /**
  * SINGLE
  */
 export type ComponentSingleOptions = {
     required?: boolean;
 };
-export type InferComponentSingle<S extends Schema, O extends ComponentSingleOptions> = O["required"] extends true ? InferSchema<S> : InferSchema<S> | null | undefined;
+export type InferComponentSingle<S extends Schema, O extends ComponentSingleOptions> = O["required"] extends true ? InferSchemaWithDefaults<S> : InferSchemaWithDefaults<S> | null | undefined;
 export declare const singleSchema: (shape: Schema, opts: ComponentSingleOptions) => ZodType;
 export type ComponentSingleField = readonly ["component.single", Schema, ComponentSingleOptions];
 /**
@@ -15,7 +15,7 @@ export type ComponentSingleField = readonly ["component.single", Schema, Compone
 export type ComponentRepeatableOptions = {
     required?: boolean;
 };
-export type InferComponentRepeatable<S extends Schema, O extends ComponentRepeatableOptions> = O["required"] extends true ? InferSchema<S>[] : InferSchema<S>[] | null | undefined;
+export type InferComponentRepeatable<S extends Schema, O extends ComponentRepeatableOptions> = O["required"] extends true ? InferSchemaWithDefaults<S>[] : InferSchemaWithDefaults<S>[] | null | undefined;
 export declare const repeatableSchema: (shape: Schema, opts: ComponentRepeatableOptions) => ZodType;
 export type ComponentRepeatableField = readonly [
     "component.repeatable",

package/dist/fields/relation.d.ts

@@ -1,4 +1,4 @@
-import { InferSchema, Schema } from "../client";
+import { InferSchemaWithDefaults, Schema } from "../client";
 /**
  * HAS MANY
  */
@@ -6,7 +6,7 @@ export type RelationHasManyOptions = {
     nullable?: boolean;
     optional?: boolean;
 };
-export type InferRelationHasMany<S extends Schema, O extends RelationHasManyOptions> = O["nullable"] extends true ? O["optional"] extends true ? InferSchema<S>[] | null | undefined : InferSchema<S>[] | null : O["optional"] extends true ? InferSchema<S>[] | undefined : InferSchema<S>[];
+export type InferRelationHasMany<S extends Schema, O extends RelationHasManyOptions> = O["nullable"] extends true ? O["optional"] extends true ? InferSchemaWithDefaults<S>[] | null | undefined : InferSchemaWithDefaults<S>[] | null : O["optional"] extends true ? InferSchemaWithDefaults<S>[] | undefined : InferSchemaWithDefaults<S>[];
 export type RelationHasManyField = readonly ["relation.hasMany", Schema, RelationHasManyOptions];
 /**
  * HAS ONE
@@ -15,7 +15,7 @@ export type RelationHasOneOptions = {
     nullable?: boolean;
     optional?: boolean;
 };
-export type InferRelationHasOne<S extends Schema, O extends RelationHasOneOptions> = O["nullable"] extends true ? O["optional"] extends true ? InferSchema<S> | null | undefined : InferSchema<S> | null : O["optional"] extends true ? InferSchema<S> | undefined : InferSchema<S>;
+export type InferRelationHasOne<S extends Schema, O extends RelationHasOneOptions> = O["nullable"] extends true ? O["optional"] extends true ? InferSchemaWithDefaults<S> | null | undefined : InferSchemaWithDefaults<S> | null : O["optional"] extends true ? InferSchemaWithDefaults<S> | undefined : InferSchemaWithDefaults<S>;
 export type RelationHasOneField = readonly ["relation.hasOne", Schema, RelationHasOneOptions];
 export declare const relation: {
     hasMany: <S = any, O extends RelationHasManyOptions = {}>(shape: S, options?: O) => ["relation.hasMany", S, O];

package/dist/utils/schema.d.ts

@@ -1,3 +1,17 @@
 import { Schema } from "../client";
 import z from "zod";
+export declare const defaultStrapiFields: {
+    id: z.ZodNumber;
+    documentId: z.ZodOptional<z.ZodString>;
+    createdAt: z.ZodOptional<z.ZodISODateTime>;
+    updatedAt: z.ZodOptional<z.ZodISODateTime>;
+    publishedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
+};
+export declare const defaultStrapiFieldsSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    documentId: z.ZodOptional<z.ZodString>;
+    createdAt: z.ZodOptional<z.ZodISODateTime>;
+    updatedAt: z.ZodOptional<z.ZodISODateTime>;
+    publishedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
+}, z.core.$strip>;
 export declare const schemaToParser: (schema: Schema) => Record<string, z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;

package/dist/utils/schema.js

@@ -6,6 +6,14 @@ import { textSchema } from "../fields/text";
 import z from "zod";
 import { enumerationSchema } from "../fields/enumeration";
 import { richTextBlocksSchema } from "../fields/richText";
+export const defaultStrapiFields = {
+    id: z.number(),
+    documentId: z.string().optional(),
+    createdAt: z.iso.datetime().optional(),
+    updatedAt: z.iso.datetime().optional(),
+    publishedAt: z.iso.datetime().nullable().optional(),
+};
+export const defaultStrapiFieldsSchema = z.object(defaultStrapiFields);
 export const schemaToParser = (schema) => {
     const shape = {};
     for (const [key, field] of Object.entries(schema)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "simple-strapi",
-  "version": "1.0.0-alpha.3",
+  "version": "1.0.0-alpha.4",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",