polen 0.11.0-next.25 → 0.11.0-next.26

package/build/api/examples/schemas/example/example.d.ts

@@ -22,9 +22,19 @@ export declare const Example: S.Struct<{
     }>, S.TaggedStruct<"DocumentVersioned", {
         versionDocuments: S.HashMap<S.Union<[typeof import("../../../../lib/version-coverage/version-coverage.js").VersionCoverageUnversioned, S.transformOrFail<S.Union<[typeof S.String, typeof S.Number]>, S.Union<[typeof import("../../../../lib/version/integer.js").Integer, typeof import("../../../../lib/version/semver.js").Semver, typeof import("../../../../lib/version/date.js").Date, typeof import("../../../../lib/version/custom.js").Custom]>, never>, S.HashSet<S.transformOrFail<S.Union<[typeof S.String, typeof S.Number]>, S.Union<[typeof import("../../../../lib/version/integer.js").Integer, typeof import("../../../../lib/version/semver.js").Semver, typeof import("../../../../lib/version/date.js").Date, typeof import("../../../../lib/version/custom.js").Custom]>, never>>]>, typeof S.String>;
     }>]>;
+    /**
+     * Optional description file for this example.
+     * Points to a markdown/MDX file that describes the example.
+     */
+    description: S.optional<S.Struct<{
+        path: typeof S.String;
+    }>>;
 }>;
 export type Example = S.Schema.Type<typeof Example>;
 export declare const make: (props: {
+    readonly description?: {
+        readonly path: string;
+    } | undefined;
     readonly path: string;
     readonly name: string;
     readonly document: {
@@ -35,6 +45,9 @@ export declare const make: (props: {
         readonly versionDocuments: import("effect/HashMap").HashMap<import("../../../../lib/version/custom.js").Custom | import("../../../../lib/version/date.js").Date | import("../../../../lib/version/integer.js").Integer | import("../../../../lib/version/semver.js").Semver | import("../../../../lib/version-coverage/version-coverage.js").VersionCoverageUnversioned | import("effect/HashSet").HashSet<import("../../../../lib/version/custom.js").Custom | import("../../../../lib/version/date.js").Date | import("../../../../lib/version/integer.js").Integer | import("../../../../lib/version/semver.js").Semver>, string>;
     };
 }, options?: S.MakeOptions) => {
+    readonly description?: {
+        readonly path: string;
+    } | undefined;
     readonly path: string;
     readonly name: string;
     readonly document: {
@@ -47,6 +60,9 @@ export declare const make: (props: {
 };
 export declare const order: Order.Order<Example>;
 export declare const equivalent: import("effect/Equivalence").Equivalence<{
+    readonly description?: {
+        readonly path: string;
+    } | undefined;
     readonly path: string;
     readonly name: string;
     readonly document: {
@@ -58,6 +74,9 @@ export declare const equivalent: import("effect/Equivalence").Equivalence<{
     };
 }>;
 export declare const is: (u: unknown, overrideOptions?: import("effect/SchemaAST").ParseOptions | number) => u is {
+    readonly description?: {
+        readonly path: string;
+    } | undefined;
     readonly path: string;
     readonly name: string;
     readonly document: {
@@ -80,7 +99,13 @@ export declare const decode: (i: {
             readonly _tag: "VersionCoverageUnversioned";
         }, string])[];
     };
+    readonly description?: {
+        readonly path: string;
+    } | undefined;
 }, overrideOptions?: import("effect/SchemaAST").ParseOptions) => import("effect/Effect").Effect<{
+    readonly description?: {
+        readonly path: string;
+    } | undefined;
     readonly path: string;
     readonly name: string;
     readonly document: {
@@ -103,7 +128,13 @@ export declare const decodeSync: (i: {
             readonly _tag: "VersionCoverageUnversioned";
         }, string])[];
     };
+    readonly description?: {
+        readonly path: string;
+    } | undefined;
 }, overrideOptions?: import("effect/SchemaAST").ParseOptions) => {
+    readonly description?: {
+        readonly path: string;
+    } | undefined;
     readonly path: string;
     readonly name: string;
     readonly document: {
@@ -115,6 +146,9 @@ export declare const decodeSync: (i: {
     };
 };
 export declare const encode: (a: {
+    readonly description?: {
+        readonly path: string;
+    } | undefined;
     readonly path: string;
     readonly name: string;
     readonly document: {
@@ -136,5 +170,8 @@ export declare const encode: (a: {
             readonly _tag: "VersionCoverageUnversioned";
         }, string])[];
     };
+    readonly description?: {
+        readonly path: string;
+    } | undefined;
 }, import("effect/ParseResult").ParseError, never>;
 //# sourceMappingURL=example.d.ts.map

package/build/api/examples/schemas/example/example.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"example.d.ts","sourceRoot":"","sources":["../../../../../src/api/examples/schemas/example/example.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAA;AACxC,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAA;AAM9B;;;GAGG;AACH,eAAO,MAAM,OAAO;IAClB;;OAEG;;IAGH;;;OAGG;;IAGH;;OAEG;;;;;;EAKH,CAAA;AAMF,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,OAAO,CAAC,CAAA;AAMnD,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;CAAe,CAAA;AAMhC,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAGtC,CAAA;AAMD,eAAO,MAAM,UAAU;;;;;;;;;;EAAyB,CAAA;AAMhD,eAAO,MAAM,EAAE;;;;;;;;;;CAAgB,CAAA;AAM/B,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;kDAAoB,CAAA;AACvC,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;CAAwB,CAAA;AAC/C,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;kDAAoB,CAAA"}
+{"version":3,"file":"example.d.ts","sourceRoot":"","sources":["../../../../../src/api/examples/schemas/example/example.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAA;AACxC,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAA;AAM9B;;;GAGG;AACH,eAAO,MAAM,OAAO;IAClB;;OAEG;;IAGH;;;OAGG;;IAGH;;OAEG;;;;;;IAGH;;;OAGG;;;;EAKH,CAAA;AAMF,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,OAAO,CAAC,CAAA;AAMnD,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;CAAe,CAAA;AAMhC,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAGtC,CAAA;AAMD,eAAO,MAAM,UAAU;;;;;;;;;;;;;EAAyB,CAAA;AAMhD,eAAO,MAAM,EAAE;;;;;;;;;;;;;CAAgB,CAAA;AAM/B,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;kDAAoB,CAAA;AACvC,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAAwB,CAAA;AAC/C,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;kDAAoB,CAAA"}

package/build/api/examples/schemas/example/example.js

@@ -22,6 +22,11 @@ export const Example = S.Struct({
      * The document content, which can be unversioned, versioned, or partially versioned.
      */
     document: Document.Document,
+    /**
+     * Optional description file for this example.
+     * Points to a markdown/MDX file that describes the example.
+     */
+    description: S.optional(S.Struct({ path: S.String })),
 }).annotations({
     identifier: 'Example',
     description: 'A GraphQL example that contains a document with optional versioning support',

package/build/api/examples/schemas/example/example.js.map

@@ -1 +1 @@
-{"version":3,"file":"example.js","sourceRoot":"","sources":["../../../../../src/api/examples/schemas/example/example.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAC1C,OAAO,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAA;AACxC,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAA;AAE9B,+EAA+E;AAC/E,SAAS;AACT,+EAA+E;AAE/E;;;GAGG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9B;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC,MAAM;IAEd;;;OAGG;IACH,IAAI,EAAE,CAAC,CAAC,MAAM;IAEd;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC,QAAQ;CAC5B,CAAC,CAAC,WAAW,CAAC;IACb,UAAU,EAAE,SAAS;IACrB,WAAW,EAAE,6EAA6E;CAC3F,CAAC,CAAA;AAQF,+EAA+E;AAC/E,eAAe;AACf,+EAA+E;AAE/E,MAAM,CAAC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;AAEhC,+EAA+E;AAC/E,WAAW;AACX,+EAA+E;AAE/E,MAAM,CAAC,MAAM,KAAK,GAAyB,KAAK,CAAC,QAAQ,CACvD,KAAK,CAAC,MAAM,EACZ,CAAC,OAAgB,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CACnC,CAAA;AAED,+EAA+E;AAC/E,cAAc;AACd,+EAA+E;AAE/E,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;AAEhD,+EAA+E;AAC/E,cAAc;AACd,+EAA+E;AAE/E,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAA;AAE/B,+EAA+E;AAC/E,QAAQ;AACR,+EAA+E;AAE/E,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;AACvC,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;AAC/C,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA"}
+{"version":3,"file":"example.js","sourceRoot":"","sources":["../../../../../src/api/examples/schemas/example/example.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAC1C,OAAO,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAA;AACxC,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAA;AAE9B,+EAA+E;AAC/E,SAAS;AACT,+EAA+E;AAE/E;;;GAGG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9B;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC,MAAM;IAEd;;;OAGG;IACH,IAAI,EAAE,CAAC,CAAC,MAAM;IAEd;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC,QAAQ;IAE3B;;;OAGG;IACH,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;CACtD,CAAC,CAAC,WAAW,CAAC;IACb,UAAU,EAAE,SAAS;IACrB,WAAW,EAAE,6EAA6E;CAC3F,CAAC,CAAA;AAQF,+EAA+E;AAC/E,eAAe;AACf,+EAA+E;AAE/E,MAAM,CAAC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;AAEhC,+EAA+E;AAC/E,WAAW;AACX,+EAA+E;AAE/E,MAAM,CAAC,MAAM,KAAK,GAAyB,KAAK,CAAC,QAAQ,CACvD,KAAK,CAAC,MAAM,EACZ,CAAC,OAAgB,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CACnC,CAAA;AAED,+EAA+E;AAC/E,cAAc;AACd,+EAA+E;AAE/E,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;AAEhD,+EAA+E;AAC/E,cAAc;AACd,+EAA+E;AAE/E,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAA;AAE/B,+EAA+E;AAC/E,QAAQ;AACR,+EAA+E;AAE/E,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;AACvC,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;AAC/C,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA"}

package/build/api/reference/$.d.ts

@@ -0,0 +1,4 @@
+export * as Catalog from './catalog.js';
+export * as Config from './config.js';
+export * from './scanner.js';
+//# sourceMappingURL=$.d.ts.map

package/build/api/reference/$.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"$.d.ts","sourceRoot":"","sources":["../../../src/api/reference/$.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,cAAc,cAAc,CAAA"}

package/build/api/reference/$.js

@@ -0,0 +1,4 @@
+export * as Catalog from './catalog.js';
+export * as Config from './config.js';
+export * from './scanner.js';
+//# sourceMappingURL=$.js.map

package/build/api/reference/$.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"$.js","sourceRoot":"","sources":["../../../src/api/reference/$.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,cAAc,cAAc,CAAA"}

package/build/api/reference/catalog.d.ts

@@ -0,0 +1,69 @@
+import { S } from '#lib/kit-temp/effect';
+export declare const Catalog: S.Struct<{
+    /**
+     * Optional index file metadata for custom reference landing page.
+     * If not provided, the app will redirect to the Query type.
+     */
+    index: S.optional<S.Struct<{
+        /**
+         * Path to the index.md or index.mdx file
+         */
+        path: typeof S.String;
+    }>>;
+}>;
+export type Catalog = S.Schema.Type<typeof Catalog>;
+export declare const make: (props: void | {
+    readonly index?: {
+        readonly path: string;
+    } | undefined;
+}, options?: S.MakeOptions) => {
+    readonly index?: {
+        readonly path: string;
+    } | undefined;
+};
+export declare const is: (u: unknown, overrideOptions?: import("effect/SchemaAST").ParseOptions | number) => u is {
+    readonly index?: {
+        readonly path: string;
+    } | undefined;
+};
+/**
+ * Check if the catalog has a custom index page
+ */
+export declare const hasIndex: (catalog: Catalog) => boolean;
+export declare const decode: (i: {
+    readonly index?: {
+        readonly path: string;
+    } | undefined;
+}, overrideOptions?: import("effect/SchemaAST").ParseOptions) => import("effect/Effect").Effect<{
+    readonly index?: {
+        readonly path: string;
+    } | undefined;
+}, import("effect/ParseResult").ParseError, never>;
+export declare const decodeSync: (i: {
+    readonly index?: {
+        readonly path: string;
+    } | undefined;
+}, overrideOptions?: import("effect/SchemaAST").ParseOptions) => {
+    readonly index?: {
+        readonly path: string;
+    } | undefined;
+};
+export declare const encode: (a: {
+    readonly index?: {
+        readonly path: string;
+    } | undefined;
+}, overrideOptions?: import("effect/SchemaAST").ParseOptions) => import("effect/Effect").Effect<{
+    readonly index?: {
+        readonly path: string;
+    } | undefined;
+}, import("effect/ParseResult").ParseError, never>;
+export declare const encodeSync: (a: {
+    readonly index?: {
+        readonly path: string;
+    } | undefined;
+}, overrideOptions?: import("effect/SchemaAST").ParseOptions) => {
+    readonly index?: {
+        readonly path: string;
+    } | undefined;
+};
+//# sourceMappingURL=catalog.d.ts.map

package/build/api/reference/catalog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../../../src/api/reference/catalog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAA;AAMxC,eAAO,MAAM,OAAO;IAClB;;;OAGG;;QAED;;WAEG;;;EAML,CAAA;AAEF,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,OAAO,CAAC,CAAA;AAMnD,eAAO,MAAM,IAAI;;;;;;;;CAAe,CAAA;AAMhC,eAAO,MAAM,EAAE;;;;CAAgB,CAAA;AAM/B;;GAEG;AACH,eAAO,MAAM,QAAQ,GAAI,SAAS,OAAO,KAAG,OAE3C,CAAA;AAMD,eAAO,MAAM,MAAM;;;;;;;;kDAAoB,CAAA;AACvC,eAAO,MAAM,UAAU;;;;;;;;CAAwB,CAAA;AAC/C,eAAO,MAAM,MAAM;;;;;;;;kDAAoB,CAAA;AACvC,eAAO,MAAM,UAAU;;;;;;;;CAAwB,CAAA"}

package/build/api/reference/catalog.js

@@ -0,0 +1,44 @@
+import { S } from '#lib/kit-temp/effect';
+// ============================================================================
+// Schema and Type
+// ============================================================================
+export const Catalog = S.Struct({
+    /**
+     * Optional index file metadata for custom reference landing page.
+     * If not provided, the app will redirect to the Query type.
+     */
+    index: S.optional(S.Struct({
+        /**
+         * Path to the index.md or index.mdx file
+         */
+        path: S.String,
+    })),
+}).annotations({
+    identifier: 'ReferenceCatalog',
+    description: 'A catalog of reference documentation metadata',
+});
+// ============================================================================
+// Constructors
+// ============================================================================
+export const make = Catalog.make;
+// ============================================================================
+// Type Guards
+// ============================================================================
+export const is = S.is(Catalog);
+// ============================================================================
+// State Predicates
+// ============================================================================
+/**
+ * Check if the catalog has a custom index page
+ */
+export const hasIndex = (catalog) => {
+    return catalog.index !== undefined;
+};
+// ============================================================================
+// Codec
+// ============================================================================
+export const decode = S.decode(Catalog);
+export const decodeSync = S.decodeSync(Catalog);
+export const encode = S.encode(Catalog);
+export const encodeSync = S.encodeSync(Catalog);
+//# sourceMappingURL=catalog.js.map

package/build/api/reference/catalog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog.js","sourceRoot":"","sources":["../../../src/api/reference/catalog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAA;AAExC,+EAA+E;AAC/E,kBAAkB;AAClB,+EAA+E;AAE/E,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9B;;;OAGG;IACH,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;QACzB;;WAEG;QACH,IAAI,EAAE,CAAC,CAAC,MAAM;KACf,CAAC,CAAC;CACJ,CAAC,CAAC,WAAW,CAAC;IACb,UAAU,EAAE,kBAAkB;IAC9B,WAAW,EAAE,+CAA+C;CAC7D,CAAC,CAAA;AAIF,+EAA+E;AAC/E,eAAe;AACf,+EAA+E;AAE/E,MAAM,CAAC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;AAEhC,+EAA+E;AAC/E,cAAc;AACd,+EAA+E;AAE/E,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAA;AAE/B,+EAA+E;AAC/E,mBAAmB;AACnB,+EAA+E;AAE/E;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,OAAgB,EAAW,EAAE;IACpD,OAAO,OAAO,CAAC,KAAK,KAAK,SAAS,CAAA;AACpC,CAAC,CAAA;AAED,+EAA+E;AAC/E,QAAQ;AACR,+EAA+E;AAE/E,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;AACvC,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;AAC/C,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;AACvC,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA"}