@adonisjs/content 1.1.0

package/build/src/loaders/gh_contributors.d.ts

@@ -0,0 +1,49 @@
+import { type Infer, type SchemaTypes } from '@vinejs/vine/types';
+import type { GithubContributorsOptions, LoaderContract } from '../types.ts';
+/**
+ * A loader that fetches GitHub contributors from all repositories in an organization.
+ * Supports caching and automatic refresh based on a schedule.
+ *
+ * @example
+ * ```ts
+ * const loader = new GithubContributorsLoader({
+ *   org: 'adonisjs',
+ *   ghToken: process.env.GITHUB_TOKEN,
+ *   outputPath: './cache/contributors.json',
+ *   refresh: 'weekly'
+ * })
+ * ```
+ */
+export declare class GithubContributorsLoader<Schema extends SchemaTypes> implements LoaderContract<Schema> {
+    #private;
+    /**
+     * Creates a new GitHub contributors loader instance.
+     *
+     * @param options - Configuration options for loading GitHub contributors
+     *
+     * @example
+     * ```ts
+     * const loader = new GithubContributorsLoader({
+     *   org: 'adonisjs',
+     *   ghToken: process.env.GITHUB_TOKEN,
+     *   outputPath: './cache/contributors.json',
+     *   refresh: 'weekly'
+     * })
+     * ```
+     */
+    constructor(options: GithubContributorsOptions);
+    /**
+     * Loads and validates GitHub contributors data.
+     * Uses cached data if available and not expired, otherwise fetches fresh data
+     * from GitHub API and updates the cache.
+     *
+     * @param schema - VineJS schema to validate the contributors data against
+     * @param metadata - Optional metadata to pass to the validator
+     *
+     * @example
+     * ```ts
+     * const contributors = await loader.load(contributorsSchema)
+     * ```
+     */
+    load(schema: Schema, metadata?: any): Promise<Infer<Schema>>;
+}

package/build/src/loaders/gh_releases.d.ts

@@ -0,0 +1,52 @@
+import { type Infer, type SchemaTypes } from '@vinejs/vine/types';
+import type { GithubReleasesOptions, LoaderContract } from '../types.ts';
+/**
+ * A loader that fetches GitHub releases from an organization's repositories.
+ * Supports caching, automatic refresh based on a schedule, and merging with existing data.
+ *
+ * @example
+ * ```ts
+ * const loader = new GithubReleasesLoader({
+ *   org: 'adonisjs',
+ *   ghToken: process.env.GITHUB_TOKEN,
+ *   outputPath: './cache/releases.json',
+ *   refresh: 'daily',
+ *   filters: {
+ *     nameDoesntInclude: ['alpha', 'beta']
+ *   }
+ * })
+ * ```
+ */
+export declare class GithubReleasesLoader<Schema extends SchemaTypes> implements LoaderContract<Schema> {
+    #private;
+    /**
+     * Creates a new GitHub release loader instance.
+     *
+     * @param options - Configuration options for loading GitHub releases
+     *
+     * @example
+     * ```ts
+     * const loader = new GithubReleasesLoader({
+     *   org: 'adonisjs',
+     *   ghToken: process.env.GITHUB_TOKEN,
+     *   outputPath: './cache/releases.json',
+     *   refresh: 'weekly'
+     * })
+     * ```
+     */
+    constructor(options: GithubReleasesOptions);
+    /**
+     * Loads and validates GitHub releases data.
+     * Uses cached data if available and not expired, otherwise fetches fresh data
+     * from GitHub API and merges with existing releases.
+     *
+     * @param schema - VineJS schema to validate the releases data against
+     * @param metadata - Optional metadata to pass to the validator
+     *
+     * @example
+     * ```ts
+     * const releases = await loader.load(releasesSchema)
+     * ```
+     */
+    load(schema: Schema, metadata?: any): Promise<Infer<Schema>>;
+}

package/build/src/loaders/gh_sponsors.d.ts

@@ -0,0 +1,56 @@
+import { type Infer, type SchemaTypes } from '@vinejs/vine/types';
+import type { GithubSponsorsOptions, LoaderContract } from '../types.ts';
+/**
+ * A loader that fetches GitHub sponsors for a user or organization.
+ * Supports caching and automatic refresh based on a schedule.
+ *
+ * @example
+ * ```ts
+ * const loader = new GithubSponsorsLoader({
+ *   login: 'adonisjs',
+ *   isOrg: true,
+ *   ghToken: process.env.GITHUB_TOKEN,
+ *   outputPath: './cache/sponsors.json',
+ *   refresh: 'daily'
+ * })
+ * ```
+ */
+export declare class GithubSponsorsLoader<Schema extends SchemaTypes> implements LoaderContract<Schema> {
+    #private;
+    /**
+     * Creates a new GitHub sponsors loader instance.
+     *
+     * @param options - Configuration options for loading GitHub sponsors
+     * @param options.login - GitHub username or organization name
+     * @param options.isOrg - Whether the login is an organization (true) or user (false)
+     * @param options.ghToken - GitHub personal access token for authentication
+     * @param options.outputPath - Path where cached sponsors will be stored
+     * @param options.refresh - Refresh schedule: 'daily', 'weekly', or 'monthly'
+     *
+     * @example
+     * ```ts
+     * const loader = new GithubSponsorsLoader({
+     *   login: 'thetutlage',
+     *   isOrg: false,
+     *   ghToken: process.env.GITHUB_TOKEN,
+     *   outputPath: './cache/sponsors.json',
+     *   refresh: 'weekly'
+     * })
+     * ```
+     */
+    constructor(options: GithubSponsorsOptions);
+    /**
+     * Loads and validates GitHub sponsors data.
+     * Uses cached data if available and not expired, otherwise fetches fresh data
+     * from GitHub API and updates the cache.
+     *
+     * @param schema - VineJS schema to validate the sponsors data against
+     * @param metadata - Optional metadata to pass to the validator
+     *
+     * @example
+     * ```ts
+     * const sponsors = await loader.load(sponsorsSchema)
+     * ```
+     */
+    load(schema: Schema, metadata?: any): Promise<Infer<Schema>>;
+}

package/build/src/loaders/json.d.ts

@@ -0,0 +1,43 @@
+import { type SchemaTypes } from '@vinejs/vine/types';
+import type { LoaderContract } from '../types.ts';
+/**
+ * A loader that reads and validates JSON data from a file.
+ * Implements the LoaderContract to provide JSON file loading with schema validation.
+ *
+ * @example
+ * ```ts
+ * const loader = new JsonLoader('./data/config.json')
+ * const collection = new Collection({
+ *   schema: configSchema,
+ *   loader,
+ *   cache: true
+ * })
+ * ```
+ */
+export declare class JsonLoader<Schema extends SchemaTypes> implements LoaderContract<Schema> {
+    #private;
+    /**
+     * Creates a new JSON loader instance.
+     *
+     * @param source - Absolute or relative path to the JSON file
+     *
+     * @example
+     * ```ts
+     * const loader = new JsonLoader('./data/menu.json')
+     * ```
+     */
+    constructor(source: string);
+    /**
+     * Loads and validates JSON data from the configured file.
+     * The directory of the source file is provided as metadata during validation.
+     *
+     * @param schema - VineJS schema to validate the loaded JSON data against
+     * @param metadata - Optional metadata to pass to the validator
+     *
+     * @example
+     * ```ts
+     * const data = await loader.load(menuSchema)
+     * ```
+     */
+    load(schema: Schema, metadata?: any): Promise<import("@vinejs/vine/types").Infer<Schema>>;
+}

package/build/src/loaders/main.d.ts

@@ -0,0 +1,91 @@
+import { type GithubSponsorsOptions, type GithubReleasesOptions, type GithubContributorsOptions } from '../types.ts';
+import { GithubSponsorsLoader } from './gh_sponsors.ts';
+import { GithubReleasesLoader } from './gh_releases.ts';
+import { GithubContributorsLoader } from './gh_contributors.ts';
+import { JsonLoader } from './json.ts';
+/**
+ * Factory functions for creating content loaders.
+ * Provides convenient access to GitHub-based data loaders.
+ *
+ * @example
+ * ```ts
+ * const sponsorsLoader = loaders.ghSponsors({
+ *   login: 'adonisjs',
+ *   isOrg: true,
+ *   ghToken: process.env.GITHUB_TOKEN,
+ *   outputPath: './cache/sponsors.json',
+ *   refresh: 'daily'
+ * })
+ *
+ * const collection = new Collection({
+ *   schema: sponsorsSchema,
+ *   loader: sponsorsLoader,
+ *   cache: true
+ * })
+ * ```
+ */
+export declare const loaders: {
+    /**
+     * Creates a GitHub sponsors loader instance.
+     *
+     * @param options - Configuration options for the sponsors loader
+     *
+     * @example
+     * ```ts
+     * const loader = loaders.ghSponsors({
+     *   login: 'adonisjs',
+     *   isOrg: true,
+     *   ghToken: process.env.GITHUB_TOKEN,
+     *   outputPath: './cache/sponsors.json',
+     *   refresh: 'daily'
+     * })
+     * ```
+     */
+    ghSponsors(options: GithubSponsorsOptions): GithubSponsorsLoader<import("@vinejs/vine/types").SchemaTypes>;
+    /**
+     * Creates a GitHub contributors loader instance.
+     *
+     * @param options - Configuration options for the contributors loader
+     *
+     * @example
+     * ```ts
+     * const loader = loaders.ghContributors({
+     *   org: 'adonisjs',
+     *   ghToken: process.env.GITHUB_TOKEN,
+     *   outputPath: './cache/contributors.json',
+     *   refresh: 'weekly'
+     * })
+     * ```
+     */
+    ghContributors(options: GithubContributorsOptions): GithubContributorsLoader<import("@vinejs/vine/types").SchemaTypes>;
+    /**
+     * Creates a GitHub releases loader instance.
+     *
+     * @param options - Configuration options for the releases loader
+     *
+     * @example
+     * ```ts
+     * const loader = loaders.ghReleases({
+     *   org: 'adonisjs',
+     *   ghToken: process.env.GITHUB_TOKEN,
+     *   outputPath: './cache/releases.json',
+     *   refresh: 'daily',
+     *   filters: {
+     *     nameDoesntInclude: ['alpha', 'beta']
+     *   }
+     * })
+     * ```
+     */
+    ghReleases(options: GithubReleasesOptions): GithubReleasesLoader<import("@vinejs/vine/types").SchemaTypes>;
+    /**
+     * Creates a JSON file loader instance.
+     *
+     * @param source - Path to the JSON file to load
+     *
+     * @example
+     * ```ts
+     * const loader = loaders.jsonLoader('./data/menu.json')
+     * ```
+     */
+    jsonLoader(source: string): JsonLoader<import("@vinejs/vine/types").SchemaTypes>;
+};