@purveyors/cli 0.9.6 → 0.15.1

package/dist/lib/manifest.d.ts

@@ -0,0 +1,107 @@
+export type CliAuthRequirement = 'none' | 'viewer' | 'member';
+export type CliOutputMode = 'json' | 'pretty' | 'csv';
+export interface CliDocLink {
+    label: string;
+    url: string;
+}
+export interface CliRoleContract {
+    role: 'viewer' | 'member';
+    description: string;
+}
+export interface CliOutputModeContract {
+    mode: CliOutputMode;
+    description: string;
+}
+export interface CliExitCodeContract {
+    exitCode: number;
+    code: string;
+    description: string;
+}
+export interface CliIdContract {
+    name: string;
+    source: string;
+    usedBy: string[];
+    note?: string;
+}
+export interface CliOptionContract {
+    flags: string;
+    description?: string;
+    defaultValue?: string | number | boolean;
+    requiredInFlagMode?: boolean;
+    notes?: string[];
+}
+export interface CliArgumentContract {
+    name: string;
+    cliToken?: string;
+    description: string;
+    required: boolean;
+    idType?: string;
+}
+export interface CliStructuredErrorContract {
+    channel: 'stderr';
+    guaranteedFields: string[];
+    optionalFields: string[];
+    when: string;
+    exception?: string;
+}
+export interface CliCommandContract {
+    name: string;
+    summary: string;
+    auth: CliAuthRequirement;
+    arguments?: CliArgumentContract[];
+    options?: CliOptionContract[];
+    notes?: string[];
+    examples?: string[];
+}
+export interface CliCommandGroupContract {
+    name: string;
+    summary: string;
+    auth: CliAuthRequirement | 'mixed';
+    command?: CliCommandContract;
+    subcommands?: CliCommandContract[];
+}
+export interface CliWorkflowContract {
+    title: string;
+    commands: string[];
+}
+export interface CliErrorPatternContract {
+    title: string;
+    exitCodes: number[];
+    guidance: string[];
+}
+export interface CliManifest {
+    schemaVersion: '1';
+    binary: string;
+    packageName: string;
+    description: string;
+    nodeVersion: string;
+    importPath: string;
+    machineSurfaces: {
+        humanReference: string;
+        shellManifest: string;
+        moduleImport: string;
+        notes: string[];
+    };
+    files: {
+        credentials: string;
+        config: string;
+    };
+    docs: CliDocLink[];
+    roles: CliRoleContract[];
+    globalOptions: CliOptionContract[];
+    outputModes: CliOutputModeContract[];
+    outputContract: {
+        stdout: string;
+        stderr: string;
+        notes: string[];
+        structuredErrors: CliStructuredErrorContract;
+    };
+    exitCodes: CliExitCodeContract[];
+    idTypes: CliIdContract[];
+    commandGroups: CliCommandGroupContract[];
+    workflows: CliWorkflowContract[];
+    errorPatterns: CliErrorPatternContract[];
+}
+export declare function getCliManifest(): CliManifest;
+export declare function renderContextText(manifest?: CliManifest): string;
+//# sourceMappingURL=manifest.d.ts.map

package/dist/lib/manifest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../../src/lib/manifest.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAC9D,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAC;AAEtD,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,aAAa,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IACzC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,QAAQ,CAAC;IAClB,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,kBAAkB,CAAC;IACzB,SAAS,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAClC,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC;IACnC,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B,WAAW,CAAC,EAAE,kBAAkB,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,aAAa,EAAE,GAAG,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE;QACf,cAAc,EAAE,MAAM,CAAC;QACvB,aAAa,EAAE,MAAM,CAAC;QACtB,YAAY,EAAE,MAAM,CAAC;QACrB,KAAK,EAAE,MAAM,EAAE,CAAC;KACjB,CAAC;IACF,KAAK,EAAE;QACL,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,IAAI,EAAE,UAAU,EAAE,CAAC;IACnB,KAAK,EAAE,eAAe,EAAE,CAAC;IACzB,aAAa,EAAE,iBAAiB,EAAE,CAAC;IACnC,WAAW,EAAE,qBAAqB,EAAE,CAAC;IACrC,cAAc,EAAE;QACd,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,gBAAgB,EAAE,0BAA0B,CAAC;KAC9C,CAAC;IACF,SAAS,EAAE,mBAAmB,EAAE,CAAC;IACjC,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,aAAa,EAAE,uBAAuB,EAAE,CAAC;IACzC,SAAS,EAAE,mBAAmB,EAAE,CAAC;IACjC,aAAa,EAAE,uBAAuB,EAAE,CAAC;CAC1C;AAwuBD,wBAAgB,cAAc,IAAI,WAAW,CA8D5C;AA4LD,wBAAgB,iBAAiB,CAAC,QAAQ,GAAE,WAA8B,GAAG,MAAM,CAmClF"}