@sanity/pkg-utils 2.2.16 → 2.3.0

package/dist/index.d.ts

@@ -79,6 +79,14 @@ export declare function check(options: {
   tsconfig?: string
 }): Promise<void>
 
+/** @internal */
+export declare function createFromTemplate(options: {
+  cwd: string
+  logger: Logger
+  packagePath: string
+  template: PkgTemplate
+}): Promise<void>
+
 /** @internal */
 export declare function createLogger(): Logger
 
@@ -91,6 +99,9 @@ export declare const DEFAULT_PKG_EXT_MAP: PkgExtMap
 /** @public */
 export declare function defineConfig(configOptions: PkgConfigOptions): PkgConfigOptions
 
+/** @public */
+export declare function defineTemplateOption<T>(option: PkgTemplateOption<T>): PkgTemplateOption<T>
+
 /** @internal */
 export declare interface DtsResult {
   type: 'dts'
@@ -137,6 +148,9 @@ export declare function getExtractMessagesConfig(options: {
 /** @internal */
 export declare function getPkgExtMap(options: {legacyExports: boolean}): PkgExtMap
 
+/** @public */
+export declare function init(options: {cwd: string; path: string}): Promise<void>
+
 /** @internal */
 export declare function isRecord(value: unknown): value is Record<string, unknown>
 
@@ -182,7 +196,16 @@ export declare interface PackageJSON {
   type?: 'commonjs' | 'module'
   version: string
   private?: boolean
+  author?:
+    | string
+    | {
+        name: string
+        email?: string
+        url?: string
+      }
   name: string
+  description?: string
+  keywords?: string[]
   bin?: Record<string, string>
   dependencies?: Record<string, string>
   devDependencies?: Record<string, string>
@@ -213,7 +236,27 @@ export declare interface PackageJSON {
   source?: string
   module?: string
   types?: string
+  files?: string[]
+  scripts?: Record<string, string>
   browserslist?: string[]
+  engines?: {
+    node?: string
+    npm?: string
+  }
+  repository?:
+    | string
+    | {
+        type: 'git'
+        url: string
+      }
+  bugs?:
+    | string
+    | {
+        url: string
+        email?: string
+      }
+  homepage?: string
+  license?: string
 }
 
 /** @internal */
@@ -353,6 +396,50 @@ export declare type PkgRuleLevel = 'error' | 'warn' | 'info' | 'off'
 /** @public */
 export declare type PkgRuntime = '*' | 'browser' | 'node'
 
+/** @public */
+export declare type PkgTemplate = PkgTemplateDefinition | PkgTemplateResolver
+
+/** @public */
+export declare interface PkgTemplateDefinition {
+  options: PkgTemplateStringOption<any>[]
+  features: {
+    name: string
+    optional: boolean
+    initial: boolean
+  }[]
+  getFiles: (
+    options: Record<string, any>,
+    features: Record<string, boolean>
+  ) => Promise<PkgTemplateFile[]>
+}
+
+/** @public */
+export declare interface PkgTemplateFile {
+  name: string
+  contents: string
+}
+
+/** @public */
+export declare type PkgTemplateOption<T = string> = PkgTemplateStringOption<T>
+
+/** @public */
+export declare type PkgTemplateResolver = (options: {
+  cwd: string
+  /** @internal */
+  logger: Logger
+  packagePath: string
+}) => PkgTemplateDefinition | Promise<PkgTemplateDefinition>
+
+/** @public */
+export declare interface PkgTemplateStringOption<T = string> {
+  name: string
+  type: 'string'
+  description: string
+  initial?: T | ((options: Record<string, any>) => T)
+  parse?: (v: string) => T | null
+  validate?: (v: string) => string | true
+}
+
 /** @internal */
 export declare function resolveBuildTasks(ctx: BuildContext): BuildTask[]