@seasketch/geoprocessing
Version:
Geoprocessing and reporting framework for SeaSketch 2.0
112 lines (111 loc) • 4.15 kB
TypeScript
import { z } from "zod";
/**
* Schema for npm package.json metadata, as found in the wild
*/
export declare const packageSchema: z.ZodObject<{
name: z.ZodString;
version: z.ZodString;
description: z.ZodString;
author: z.ZodString;
license: z.ZodString;
homepage: z.ZodOptional<z.ZodString>;
bugs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
repository: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
dependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
devDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
scripts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
private: z.ZodOptional<z.ZodBoolean>;
type: z.ZodOptional<z.ZodString>;
keywords: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
repositoryUrl: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
name: string;
version: string;
description: string;
author: string;
license: string;
type?: string | undefined;
homepage?: string | undefined;
bugs?: Record<string, string> | undefined;
repository?: Record<string, string> | undefined;
dependencies?: Record<string, string> | undefined;
devDependencies?: Record<string, string> | undefined;
scripts?: Record<string, string> | undefined;
private?: boolean | undefined;
keywords?: string[] | undefined;
repositoryUrl?: string | undefined;
}, {
name: string;
version: string;
description: string;
author: string;
license: string;
type?: string | undefined;
homepage?: string | undefined;
bugs?: Record<string, string> | undefined;
repository?: Record<string, string> | undefined;
dependencies?: Record<string, string> | undefined;
devDependencies?: Record<string, string> | undefined;
scripts?: Record<string, string> | undefined;
private?: boolean | undefined;
keywords?: string[] | undefined;
repositoryUrl?: string | undefined;
}>;
/**
* Stricter schema for npm package.json metadata, with most fields guaranteed present
*/
export declare const loadedPackageSchema: z.ZodObject<{
name: z.ZodString;
version: z.ZodString;
description: z.ZodString;
author: z.ZodString;
license: z.ZodString;
homepage: z.ZodOptional<z.ZodString>;
bugs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
repository: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
dependencies: z.ZodRecord<z.ZodString, z.ZodString>;
devDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
scripts: z.ZodRecord<z.ZodString, z.ZodString>;
private: z.ZodBoolean;
type: z.ZodOptional<z.ZodString>;
keywords: z.ZodArray<z.ZodString, "many">;
repositoryUrl: z.ZodOptional<z.ZodString>;
"lint-staged": z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
}, "strip", z.ZodTypeAny, {
name: string;
version: string;
description: string;
author: string;
license: string;
dependencies: Record<string, string>;
scripts: Record<string, string>;
private: boolean;
keywords: string[];
type?: string | undefined;
homepage?: string | undefined;
bugs?: Record<string, string> | undefined;
repository?: Record<string, string> | undefined;
devDependencies?: Record<string, string> | undefined;
repositoryUrl?: string | undefined;
"lint-staged"?: Record<string, string> | undefined;
}, {
name: string;
version: string;
description: string;
author: string;
license: string;
dependencies: Record<string, string>;
scripts: Record<string, string>;
private: boolean;
keywords: string[];
type?: string | undefined;
homepage?: string | undefined;
bugs?: Record<string, string> | undefined;
repository?: Record<string, string> | undefined;
devDependencies?: Record<string, string> | undefined;
repositoryUrl?: string | undefined;
"lint-staged"?: Record<string, string> | undefined;
}>;
/** Represents a single JS package */
export type Package = z.infer<typeof packageSchema>;
export type LoadedPackage = z.infer<typeof loadedPackageSchema>;