@settlemint/sdk-utils 2.3.5 → 2.3.8-main9d094739

package/dist/environment.d.cts

@@ -1,19 +1,7 @@
 import { ZodString, ZodType, z } from "zod/v4";
 
 //#region src/validation/validate.d.ts
-/**
-* Validates a value against a given Zod schema.
-*
-* @param schema - The Zod schema to validate against.
-* @param value - The value to validate.
-* @returns The validated and parsed value.
-* @throws Will throw an error if validation fails, with formatted error messages.
-*
-* @example
-* import { validate } from "@settlemint/sdk-utils/validation";
-*
-* const validatedId = validate(IdSchema, "550e8400-e29b-41d4-a716-446655440000");
-*/
+
 /**
  * Validates a value against a given Zod schema.
  *
@@ -28,7 +16,6 @@ import { ZodString, ZodType, z } from "zod/v4";
  * const validatedId = validate(IdSchema, "550e8400-e29b-41d4-a716-446655440000");
  */
 declare function validate<T extends ZodType>(schema: T, value: unknown): T["_output"];
-
 //#endregion
 //#region src/validation/access-token.schema.d.ts
 /**
@@ -49,20 +36,23 @@ type PersonalAccessToken = z.infer<typeof PersonalAccessTokenSchema>;
  */
 declare const AccessTokenSchema: ZodString;
 type AccessToken = z.infer<typeof AccessTokenSchema>;
-
 //#endregion
 //#region src/validation/dot-env.schema.d.ts
 /**
  * Use this value to indicate that the resources are not part of the SettleMint platform.
  */
 declare const STANDALONE_INSTANCE = "standalone";
+/**
+ * Use this value to indicate that the resources are not part of the SettleMint platform.
+ */
+declare const LOCAL_INSTANCE = "local";
 /**
  * Schema for validating environment variables used by the SettleMint SDK.
  * Defines validation rules and types for configuration values like URLs,
  * access tokens, workspace names, and service endpoints.
  */
 declare const DotEnvSchema: z.ZodObject<{
-  SETTLEMINT_INSTANCE: z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"standalone">]>>;
+  SETTLEMINT_INSTANCE: z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"standalone">, z.ZodLiteral<"local">]>>;
   SETTLEMINT_ACCESS_TOKEN: z.ZodOptional<z.ZodString>;
   SETTLEMINT_PERSONAL_ACCESS_TOKEN: z.ZodOptional<z.ZodString>;
   SETTLEMINT_WORKSPACE: z.ZodOptional<z.ZodString>;
@@ -118,7 +108,7 @@ type DotEnv = z.infer<typeof DotEnvSchema>;
  * Useful for validating incomplete configurations during development or build time.
  */
 declare const DotEnvSchemaPartial: z.ZodObject<{
-  SETTLEMINT_INSTANCE: z.ZodOptional<z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"standalone">]>>>;
+  SETTLEMINT_INSTANCE: z.ZodOptional<z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"standalone">, z.ZodLiteral<"local">]>>>;
   SETTLEMINT_ACCESS_TOKEN: z.ZodOptional<z.ZodOptional<z.ZodString>>;
   SETTLEMINT_PERSONAL_ACCESS_TOKEN: z.ZodOptional<z.ZodOptional<z.ZodString>>;
   SETTLEMINT_WORKSPACE: z.ZodOptional<z.ZodOptional<z.ZodString>>;
@@ -169,7 +159,6 @@ declare const DotEnvSchemaPartial: z.ZodObject<{
  * Type definition for the partial environment variables schema.
  */
 type DotEnvPartial = z.infer<typeof DotEnvSchemaPartial>;
-
 //#endregion
 //#region src/validation/id.schema.d.ts
 /**
@@ -192,7 +181,6 @@ declare const IdSchema: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
  * Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
  */
 type Id = z.infer<typeof IdSchema>;
-
 //#endregion
 //#region src/validation/unique-name.schema.d.ts
 /**
@@ -216,7 +204,6 @@ declare const UniqueNameSchema: z.ZodString;
  * Type definition for unique names, inferred from UniqueNameSchema.
  */
 type UniqueName = z.infer<typeof UniqueNameSchema>;
-
 //#endregion
 //#region src/validation/url.schema.d.ts
 /**
@@ -267,7 +254,6 @@ type UrlPath = z.infer<typeof UrlPathSchema>;
  */
 declare const UrlOrPathSchema: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
 type UrlOrPath = z.infer<typeof UrlOrPathSchema>;
-
 //#endregion
 //#region src/environment/load-env.d.ts
 /**
@@ -290,7 +276,6 @@ type UrlOrPath = z.infer<typeof UrlOrPathSchema>;
  * const rawEnv = await loadEnv(false, false);
  */
 declare function loadEnv<T extends boolean = true>(validateEnv: T, prod: boolean, path?: string): Promise<T extends true ? DotEnv : DotEnvPartial>;
-
 //#endregion
 //#region src/environment/write-env.d.ts
 /**
@@ -335,7 +320,6 @@ declare function writeEnv({
   secrets: boolean;
   cwd?: string;
 }): Promise<void>;
-
 //#endregion
 export { loadEnv, writeEnv };
 //# sourceMappingURL=environment.d.cts.map

package/dist/environment.d.ts

@@ -1,19 +1,7 @@
 import { ZodString, ZodType, z } from "zod/v4";
 
 //#region src/validation/validate.d.ts
-/**
-* Validates a value against a given Zod schema.
-*
-* @param schema - The Zod schema to validate against.
-* @param value - The value to validate.
-* @returns The validated and parsed value.
-* @throws Will throw an error if validation fails, with formatted error messages.
-*
-* @example
-* import { validate } from "@settlemint/sdk-utils/validation";
-*
-* const validatedId = validate(IdSchema, "550e8400-e29b-41d4-a716-446655440000");
-*/
+
 /**
  * Validates a value against a given Zod schema.
  *
@@ -28,7 +16,6 @@ import { ZodString, ZodType, z } from "zod/v4";
  * const validatedId = validate(IdSchema, "550e8400-e29b-41d4-a716-446655440000");
  */
 declare function validate<T extends ZodType>(schema: T, value: unknown): T["_output"];
-
 //#endregion
 //#region src/validation/access-token.schema.d.ts
 /**
@@ -49,20 +36,23 @@ type PersonalAccessToken = z.infer<typeof PersonalAccessTokenSchema>;
  */
 declare const AccessTokenSchema: ZodString;
 type AccessToken = z.infer<typeof AccessTokenSchema>;
-
 //#endregion
 //#region src/validation/dot-env.schema.d.ts
 /**
  * Use this value to indicate that the resources are not part of the SettleMint platform.
  */
 declare const STANDALONE_INSTANCE = "standalone";
+/**
+ * Use this value to indicate that the resources are not part of the SettleMint platform.
+ */
+declare const LOCAL_INSTANCE = "local";
 /**
  * Schema for validating environment variables used by the SettleMint SDK.
  * Defines validation rules and types for configuration values like URLs,
  * access tokens, workspace names, and service endpoints.
  */
 declare const DotEnvSchema: z.ZodObject<{
-  SETTLEMINT_INSTANCE: z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"standalone">]>>;
+  SETTLEMINT_INSTANCE: z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"standalone">, z.ZodLiteral<"local">]>>;
   SETTLEMINT_ACCESS_TOKEN: z.ZodOptional<z.ZodString>;
   SETTLEMINT_PERSONAL_ACCESS_TOKEN: z.ZodOptional<z.ZodString>;
   SETTLEMINT_WORKSPACE: z.ZodOptional<z.ZodString>;
@@ -118,7 +108,7 @@ type DotEnv = z.infer<typeof DotEnvSchema>;
  * Useful for validating incomplete configurations during development or build time.
  */
 declare const DotEnvSchemaPartial: z.ZodObject<{
-  SETTLEMINT_INSTANCE: z.ZodOptional<z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"standalone">]>>>;
+  SETTLEMINT_INSTANCE: z.ZodOptional<z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"standalone">, z.ZodLiteral<"local">]>>>;
   SETTLEMINT_ACCESS_TOKEN: z.ZodOptional<z.ZodOptional<z.ZodString>>;
   SETTLEMINT_PERSONAL_ACCESS_TOKEN: z.ZodOptional<z.ZodOptional<z.ZodString>>;
   SETTLEMINT_WORKSPACE: z.ZodOptional<z.ZodOptional<z.ZodString>>;
@@ -169,7 +159,6 @@ declare const DotEnvSchemaPartial: z.ZodObject<{
  * Type definition for the partial environment variables schema.
  */
 type DotEnvPartial = z.infer<typeof DotEnvSchemaPartial>;
-
 //#endregion
 //#region src/validation/id.schema.d.ts
 /**
@@ -192,7 +181,6 @@ declare const IdSchema: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
  * Can be either a PostgreSQL UUID string or MongoDB ObjectID string.
  */
 type Id = z.infer<typeof IdSchema>;
-
 //#endregion
 //#region src/validation/unique-name.schema.d.ts
 /**
@@ -216,7 +204,6 @@ declare const UniqueNameSchema: z.ZodString;
  * Type definition for unique names, inferred from UniqueNameSchema.
  */
 type UniqueName = z.infer<typeof UniqueNameSchema>;
-
 //#endregion
 //#region src/validation/url.schema.d.ts
 /**
@@ -267,7 +254,6 @@ type UrlPath = z.infer<typeof UrlPathSchema>;
  */
 declare const UrlOrPathSchema: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
 type UrlOrPath = z.infer<typeof UrlOrPathSchema>;
-
 //#endregion
 //#region src/environment/load-env.d.ts
 /**
@@ -290,7 +276,6 @@ type UrlOrPath = z.infer<typeof UrlOrPathSchema>;
  * const rawEnv = await loadEnv(false, false);
  */
 declare function loadEnv<T extends boolean = true>(validateEnv: T, prod: boolean, path?: string): Promise<T extends true ? DotEnv : DotEnvPartial>;
-
 //#endregion
 //#region src/environment/write-env.d.ts
 /**
@@ -335,7 +320,6 @@ declare function writeEnv({
   secrets: boolean;
   cwd?: string;
 }): Promise<void>;
-
 //#endregion
 export { loadEnv, writeEnv };
 //# sourceMappingURL=environment.d.ts.map