@cedarjs/project-config 0.0.4

package/dist/cjs/paths.d.ts

@@ -0,0 +1,142 @@
+export interface NodeTargetPaths {
+    base: string;
+    dataMigrations: string;
+    directives: string;
+    db: string;
+    dbSchema: string;
+    src: string;
+    functions: string;
+    graphql: string;
+    lib: string;
+    generators: string;
+    services: string;
+    config: string;
+    dist: string;
+    types: string;
+    models: string;
+    mail: string;
+    jobs: string;
+    distJobs: string;
+    jobsConfig: string | null;
+    distJobsConfig: string | null;
+    logger: string | null;
+}
+export interface WebPaths {
+    base: string;
+    src: string;
+    storybook: string;
+    app: string;
+    document: string;
+    generators: string;
+    html: string;
+    routes: string;
+    pages: string;
+    components: string;
+    layouts: string;
+    config: string;
+    viteConfig: string;
+    entryClient: string | null;
+    entryServer: string | null;
+    postcss: string;
+    storybookConfig: string;
+    storybookPreviewConfig: string | null;
+    storybookManagerConfig: string;
+    dist: string;
+    distBrowser: string;
+    distRsc: string;
+    distSsr: string;
+    distSsrDocument: string;
+    distSsrEntryServer: string;
+    distRouteHooks: string;
+    distRscEntries: string;
+    routeManifest: string;
+    types: string;
+    graphql: string;
+}
+export interface Paths {
+    base: string;
+    generated: {
+        base: string;
+        schema: string;
+        types: {
+            includes: string;
+            mirror: string;
+        };
+        prebuild: string;
+    };
+    web: WebPaths;
+    api: NodeTargetPaths;
+    scripts: string;
+}
+export interface PagesDependency {
+    /** the variable to which the import is assigned */
+    importName: string;
+    /** @alias importName */
+    constName: string;
+    /** absolute path without extension */
+    importPath: string;
+    /** absolute path with extension */
+    path: string;
+    /** const ${importName} = { ...data structure for async imports... } */
+    importStatement: string;
+}
+/**
+ * The Redwood config file is used as an anchor for the base directory of a project.
+ */
+export declare const getBaseDir: (configPath?: string) => string;
+export declare const getBaseDirFromFile: (file: string) => string;
+/**
+ * Use this to resolve files when the path to the file is known,
+ * but the extension is not.
+ */
+export declare const resolveFile: (filePath: string, extensions?: string[]) => string | null;
+export declare const getPaths: (BASE_DIR?: string) => Paths;
+/**
+ * Returns the route hook for the supplied page path.
+ * Note that the page name doesn't have to match
+ *
+ * @param pagePath
+ * @returns string
+ */
+export declare const getRouteHookForPage: (pagePath: string | undefined | null) => string | null;
+/**
+ * Use this function to find the app route hook.
+ * If it is present, you get the path to the file - in prod, you get the built version in dist.
+ * In dev, you get the source version.
+ *
+ * @param forProd
+ * @returns string | null
+ */
+export declare const getAppRouteHook: (forProd?: boolean) => string | null;
+/**
+ * Process the pages directory and return information useful for automated imports.
+ *
+ * Note: glob.sync returns posix style paths on Windows machines
+ * @deprecated I will write a seperate method that use `getFiles` instead. This
+ * is used by structure, babel auto-importer and the eslint plugin.
+ */
+export declare const processPagesDir: (webPagesDir?: string) => PagesDependency[];
+/**
+ * Converts Windows-style paths to Posix-style
+ * C:\Users\Bob\dev\Redwood -> /c/Users/Bob/dev/Redwood
+ *
+ * The conversion only happens on Windows systems, and only for paths that are
+ * not already Posix-style
+ *
+ * @param path Filesystem path
+ */
+export declare const ensurePosixPath: (path: string) => string;
+/**
+ * Switches backslash to regular slash on Windows so the path works in
+ * import statements
+ * C:\Users\Bob\dev\Redwood\UserPage\UserPage ->
+ * C:/Users/Bob/dev/Redwood/UserPage/UserPage
+ *
+ * @param path Filesystem path
+ */
+export declare const importStatementPath: (path: string) => string;
+export declare function projectRootIsEsm(): boolean;
+export declare function projectSideIsEsm(side: 'api' | 'web'): boolean;
+export declare function projectIsEsm(): boolean;
+export declare const isTypeScriptProject: () => boolean;
+//# sourceMappingURL=paths.d.ts.map

package/dist/cjs/paths.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.d.ts","sourceRoot":"","sources":["../../src/paths.ts"],"names":[],"mappings":"AAQA,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,cAAc,EAAE,MAAM,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;CACtB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,eAAe,EAAE,MAAM,CAAA;IACvB,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAA;IACrC,sBAAsB,EAAE,MAAM,CAAA;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,eAAe,EAAE,MAAM,CAAA;IACvB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,cAAc,EAAE,MAAM,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;IACtB,aAAa,EAAE,MAAM,CAAA;IACrB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE;QACT,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,MAAM,CAAA;QACd,KAAK,EAAE;YACL,QAAQ,EAAE,MAAM,CAAA;YAChB,MAAM,EAAE,MAAM,CAAA;SACf,CAAA;QACD,QAAQ,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,GAAG,EAAE,QAAQ,CAAA;IACb,GAAG,EAAE,eAAe,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,eAAe;IAC9B,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAA;IAClB,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,sCAAsC;IACtC,UAAU,EAAE,MAAM,CAAA;IAClB,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,uEAAuE;IACvE,eAAe,EAAE,MAAM,CAAA;CACxB;AAiDD;;GAEG;AACH,eAAO,MAAM,UAAU,gBAAgB,MAAM,KAAqB,MAEjE,CAAA;AAED,eAAO,MAAM,kBAAkB,SAAU,MAAM,WAE9C,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,aACZ,MAAM,eACJ,MAAM,EAAE,KACnB,MAAM,GAAG,IAQX,CAAA;AAMD,eAAO,MAAM,QAAQ,cAAc,MAAM,KAAkB,KA0G1D,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,aAAc,MAAM,GAAG,SAAS,GAAG,IAAI,kBAetE,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,sCAmB3B,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,iBACb,MAAM,KAClB,eAAe,EAsBjB,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,SAAU,MAAM,WAa3C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,SAAU,MAAM,WAQ/C,CAAA;AAWD,wBAAgB,gBAAgB,YAE/B;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,KAAK,GAAG,KAAK,WAKnD;AAED,wBAAgB,YAAY,YAY3B;AAED,eAAO,MAAM,mBAAmB,eAM/B,CAAA"}

package/dist/config.d.ts

@@ -0,0 +1,126 @@
+import * as toml from 'smol-toml';
+export declare enum TargetEnum {
+    NODE = "node",
+    BROWSER = "browser",
+    REACT_NATIVE = "react-native",
+    ELECTRON = "electron"
+}
+export interface NodeTargetConfig {
+    title: string;
+    name?: string;
+    host?: string;
+    port: number;
+    path: string;
+    target: TargetEnum.NODE;
+    schemaPath: string;
+    serverConfig: string;
+    debugPort?: number;
+}
+interface BrowserTargetConfig {
+    title: string;
+    name?: string;
+    host?: string;
+    port: number;
+    path: string;
+    target: TargetEnum.BROWSER;
+    includeEnvironmentVariables: string[];
+    /**
+     * Specify the URL to your api-server.
+     * This can be an absolute path proxied on the current domain (`/.netlify/functions`),
+     * or a fully qualified URL (`https://api.example.org:8911/functions`).
+     *
+     * Note: This should not include the path to the GraphQL Server.
+     **/
+    apiUrl: string;
+    /**
+     * Optional: FQDN or absolute path to the GraphQL serverless function, without the trailing slash.
+     * This will override the apiUrl configuration just for the graphql function
+     * Example: `./redwood/functions/graphql` or `https://api.redwoodjs.com/graphql`
+     */
+    apiGraphQLUrl?: string;
+    fastRefresh: boolean;
+    a11y: boolean;
+    sourceMap: boolean;
+}
+interface GraphiQLStudioConfig {
+    endpoint?: string;
+    authImpersonation?: AuthImpersonationConfig;
+}
+type SupportedAuthImpersonationProviders = 'dbAuth' | 'netlify' | 'supabase';
+interface AuthImpersonationConfig {
+    authProvider?: SupportedAuthImpersonationProviders;
+    jwtSecret?: string;
+    userId?: string;
+    email?: string;
+    roles?: string[];
+}
+interface StudioConfig {
+    basePort: number;
+    graphiql?: GraphiQLStudioConfig;
+}
+export interface Config {
+    web: BrowserTargetConfig;
+    api: NodeTargetConfig;
+    browser: {
+        open: boolean | string;
+    };
+    generate: {
+        tests: boolean;
+        stories: boolean;
+        nestScaffoldByModel: boolean;
+    };
+    graphql: {
+        fragments: boolean;
+        trustedDocuments: boolean;
+        includeScalars: {
+            File: boolean;
+        };
+    };
+    notifications: {
+        versionUpdates: string[];
+    };
+    studio: StudioConfig;
+    experimental: {
+        opentelemetry: {
+            enabled: boolean;
+            wrapApi: boolean;
+            apiSdk?: string;
+        };
+        cli: {
+            autoInstall: boolean;
+            plugins: CLIPlugin[];
+        };
+        useSDLCodeGenForGraphQLTypes: boolean;
+        streamingSsr: {
+            enabled: boolean;
+        };
+        rsc: {
+            enabled: boolean;
+        };
+        realtime: {
+            enabled: boolean;
+        };
+        reactCompiler: {
+            enabled: boolean;
+            lintOnly: boolean;
+        };
+    };
+}
+export interface CLIPlugin {
+    package: string;
+    enabled?: boolean;
+}
+/**
+ * These configuration options are modified by the user via the Redwood
+ * config file.
+ */
+export declare const getConfig: (configPath?: string) => Config;
+/**
+ * Returns the JSON parse of the config file without any default values.
+ *
+ * @param configPath Path to the config file, defaults to automatically find the project `redwood.toml` file
+ * @returns A JSON object from the parsed toml values
+ */
+export declare function getRawConfig(configPath?: string): Record<string, toml.TomlPrimitive>;
+export {};
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAKjC,oBAAY,UAAU;IACpB,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,YAAY,iBAAiB;IAC7B,QAAQ,aAAa;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,UAAU,CAAC,IAAI,CAAA;IACvB,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,UAAU,mBAAmB;IAC3B,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,UAAU,CAAC,OAAO,CAAA;IAC1B,2BAA2B,EAAE,MAAM,EAAE,CAAA;IACrC;;;;;;QAMI;IACJ,MAAM,EAAE,MAAM,CAAA;IACd;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB,WAAW,EAAE,OAAO,CAAA;IACpB,IAAI,EAAE,OAAO,CAAA;IACb,SAAS,EAAE,OAAO,CAAA;CACnB;AAED,UAAU,oBAAoB;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,iBAAiB,CAAC,EAAE,uBAAuB,CAAA;CAC5C;AAED,KAAK,mCAAmC,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,CAAA;AAE5E,UAAU,uBAAuB;IAC/B,YAAY,CAAC,EAAE,mCAAmC,CAAA;IAClD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;CACjB;AAED,UAAU,YAAY;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,oBAAoB,CAAA;CAChC;AAED,MAAM,WAAW,MAAM;IACrB,GAAG,EAAE,mBAAmB,CAAA;IACxB,GAAG,EAAE,gBAAgB,CAAA;IACrB,OAAO,EAAE;QACP,IAAI,EAAE,OAAO,GAAG,MAAM,CAAA;KACvB,CAAA;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,OAAO,CAAA;QACd,OAAO,EAAE,OAAO,CAAA;QAChB,mBAAmB,EAAE,OAAO,CAAA;KAC7B,CAAA;IACD,OAAO,EAAE;QACP,SAAS,EAAE,OAAO,CAAA;QAClB,gBAAgB,EAAE,OAAO,CAAA;QACzB,cAAc,EAAE;YACd,IAAI,EAAE,OAAO,CAAA;SACd,CAAA;KACF,CAAA;IACD,aAAa,EAAE;QACb,cAAc,EAAE,MAAM,EAAE,CAAA;KACzB,CAAA;IACD,MAAM,EAAE,YAAY,CAAA;IACpB,YAAY,EAAE;QACZ,aAAa,EAAE;YACb,OAAO,EAAE,OAAO,CAAA;YAChB,OAAO,EAAE,OAAO,CAAA;YAChB,MAAM,CAAC,EAAE,MAAM,CAAA;SAChB,CAAA;QACD,GAAG,EAAE;YACH,WAAW,EAAE,OAAO,CAAA;YACpB,OAAO,EAAE,SAAS,EAAE,CAAA;SACrB,CAAA;QACD,4BAA4B,EAAE,OAAO,CAAA;QACrC,YAAY,EAAE;YACZ,OAAO,EAAE,OAAO,CAAA;SACjB,CAAA;QACD,GAAG,EAAE;YACH,OAAO,EAAE,OAAO,CAAA;SACjB,CAAA;QACD,QAAQ,EAAE;YACR,OAAO,EAAE,OAAO,CAAA;SACjB,CAAA;QACD,aAAa,EAAE;YACb,OAAO,EAAE,OAAO,CAAA;YAChB,QAAQ,EAAE,OAAO,CAAA;SAClB,CAAA;KACF,CAAA;CACF;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAmFD;;;GAGG;AACH,eAAO,MAAM,SAAS,2BAAmC,MAMxD,CAAA;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,UAAU,SAAkB,sCAMxD"}

package/dist/configPath.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Search the parent directories for the Redwood configuration file.
+ */
+export declare const getConfigPath: (cwd?: string) => string;
+//# sourceMappingURL=configPath.d.ts.map

package/dist/configPath.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configPath.d.ts","sourceRoot":"","sources":["../src/configPath.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,eAAO,MAAM,aAAa,SACnB,MAAM,KACV,MAkBF,CAAA"}

package/dist/findUp.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Find a file by walking up parent directories.
+ */
+export declare function findUp(file: string, startingDirectory?: string): string | null;
+//# sourceMappingURL=findUp.d.ts.map

package/dist/findUp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findUp.d.ts","sourceRoot":"","sources":["../src/findUp.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,MAAM,EACZ,iBAAiB,GAAE,MAAsB,GACxC,MAAM,GAAG,IAAI,CAef"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './config.js';
+export * from './configPath.js';
+export * from './paths.js';
+export * from './findUp.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA"}