@znemz/cfn-include 2.1.23 → 4.0.0

package/dist/types/template.d.ts

@@ -0,0 +1,290 @@
+/**
+ * CloudFormation Template Type Definitions
+ */
+/**
+ * Any valid template value (recursive)
+ */
+export type TemplateValue = string | number | boolean | null | undefined | TemplateValue[] | TemplateObject | IntrinsicFunction;
+/**
+ * Plain template object (not an intrinsic function)
+ */
+export interface TemplateObject {
+    [key: string]: TemplateValue;
+}
+/**
+ * CloudFormation template document
+ */
+export interface TemplateDocument {
+    AWSTemplateFormatVersion?: '2010-09-09';
+    Description?: string;
+    Metadata?: TemplateMetadata;
+    Parameters?: Record<string, TemplateParameter>;
+    Mappings?: Record<string, Record<string, Record<string, TemplateValue>>>;
+    Conditions?: Record<string, IntrinsicFunction>;
+    Transform?: string | string[];
+    Resources?: Record<string, Resource>;
+    Outputs?: Record<string, Output>;
+    [key: string]: any;
+}
+/**
+ * Template metadata section
+ */
+export interface TemplateMetadata {
+    CfnInclude?: {
+        GitCommit?: string;
+        BuildDate?: string;
+    };
+    [key: string]: unknown;
+}
+/**
+ * CloudFormation parameter definition
+ */
+export interface TemplateParameter {
+    Type: string;
+    Default?: TemplateValue;
+    Description?: string;
+    AllowedPattern?: string;
+    AllowedValues?: string[];
+    ConstraintDescription?: string;
+    MaxLength?: number;
+    MaxValue?: number;
+    MinLength?: number;
+    MinValue?: number;
+    NoEcho?: boolean;
+}
+/**
+ * CloudFormation resource definition
+ */
+export interface Resource {
+    Type: string;
+    Condition?: string;
+    DependsOn?: string | string[];
+    DeletionPolicy?: 'Delete' | 'Retain' | 'Snapshot';
+    UpdatePolicy?: Record<string, unknown>;
+    UpdateReplacePolicy?: 'Delete' | 'Retain' | 'Snapshot';
+    CreationPolicy?: Record<string, unknown>;
+    Metadata?: Record<string, unknown>;
+    Properties?: Record<string, TemplateValue>;
+}
+/**
+ * CloudFormation output definition
+ */
+export interface Output {
+    Value: TemplateValue;
+    Description?: string;
+    Condition?: string;
+    Export?: {
+        Name: TemplateValue;
+    };
+}
+/**
+ * Union of all intrinsic function types
+ */
+export type IntrinsicFunction = FnInclude | FnMap | FnMerge | FnDeepMerge | FnFlatten | FnFlattenDeep | FnUniq | FnCompact | FnConcat | FnSort | FnSortedUniq | FnSortBy | FnSortObject | FnWithout | FnOmit | FnOmitEmpty | FnLength | FnStringify | FnStringSplit | FnObjectKeys | FnObjectValues | FnFilenames | FnSequence | FnOutputs | FnGetEnv | FnUpperCamelCase | FnLowerCamelCase | FnEval | FnIfEval | FnJoinNow | FnSubNow | FnRefNow | FnApplyTags | FnBase64 | FnFindInMap | FnGetAtt | FnGetAZs | FnImportValue | FnJoin | FnSelect | FnSub | FnSplit | FnRef | FnCidr | FnGetParam | FnAnd | FnEquals | FnIf | FnNot | FnOr | Condition;
+export interface FnInclude {
+    'Fn::Include': string | FnIncludeOptions | [string, string?, string?];
+}
+export interface FnIncludeOptions {
+    location: string;
+    type?: 'json' | 'string' | 'literal';
+    query?: string | TemplateValue;
+    parser?: 'lodash' | 'jmespath';
+    context?: Record<string, TemplateValue>;
+    inject?: Record<string, string>;
+    isGlob?: boolean;
+    ignoreMissingVar?: boolean;
+    ignoreMissingFile?: boolean;
+    doEnv?: boolean;
+    doEval?: boolean;
+    doLog?: boolean;
+}
+export interface FnMap {
+    'Fn::Map': [TemplateValue, TemplateValue] | [TemplateValue, string | string[], TemplateValue];
+}
+export interface FnMerge {
+    'Fn::Merge': TemplateValue[];
+}
+export interface FnDeepMerge {
+    'Fn::DeepMerge': TemplateValue[];
+}
+export interface FnFlatten {
+    'Fn::Flatten': TemplateValue;
+}
+export interface FnFlattenDeep {
+    'Fn::FlattenDeep': TemplateValue;
+}
+export interface FnUniq {
+    'Fn::Uniq': TemplateValue;
+}
+export interface FnCompact {
+    'Fn::Compact': TemplateValue;
+}
+export interface FnConcat {
+    'Fn::Concat': TemplateValue[];
+}
+export interface FnSort {
+    'Fn::Sort': TemplateValue;
+}
+export interface FnSortedUniq {
+    'Fn::SortedUniq': TemplateValue;
+}
+export interface FnSortBy {
+    'Fn::SortBy': {
+        list: TemplateValue;
+        iteratees: string | string[];
+    };
+}
+export interface FnSortObject {
+    'Fn::SortObject': {
+        object?: TemplateValue;
+        options?: Record<string, unknown>;
+    } | TemplateValue;
+}
+export interface FnWithout {
+    'Fn::Without': [TemplateValue[], TemplateValue[]] | {
+        list: TemplateValue[];
+        withouts: TemplateValue[];
+    };
+}
+export interface FnOmit {
+    'Fn::Omit': [TemplateObject, string[]] | {
+        object: TemplateObject;
+        omits: string[];
+    };
+}
+export interface FnOmitEmpty {
+    'Fn::OmitEmpty': TemplateObject;
+}
+export interface FnLength {
+    'Fn::Length': TemplateValue;
+}
+export interface FnStringify {
+    'Fn::Stringify': TemplateValue;
+}
+export interface FnStringSplit {
+    'Fn::StringSplit': {
+        string: string;
+        separator?: string;
+        doLog?: boolean;
+    };
+}
+export interface FnObjectKeys {
+    'Fn::ObjectKeys': TemplateValue;
+}
+export interface FnObjectValues {
+    'Fn::ObjectValues': TemplateValue;
+}
+export interface FnFilenames {
+    'Fn::Filenames': string | {
+        location: string;
+        omitExtension?: boolean;
+        doLog?: boolean;
+    };
+}
+export interface FnSequence {
+    'Fn::Sequence': [number | string, number | string, number?];
+}
+export interface FnOutputs {
+    'Fn::Outputs': Record<string, TemplateValue>;
+}
+export interface FnGetEnv {
+    'Fn::GetEnv': string | [string, TemplateValue];
+}
+export interface FnUpperCamelCase {
+    'Fn::UpperCamelCase': string;
+}
+export interface FnLowerCamelCase {
+    'Fn::LowerCamelCase': string;
+}
+export interface FnEval {
+    'Fn::Eval': {
+        state?: unknown;
+        script: string;
+        inject?: Record<string, string>;
+        doLog?: boolean;
+    };
+}
+export interface FnIfEval {
+    'Fn::IfEval': {
+        evalCond: string;
+        truthy?: TemplateValue;
+        falsy?: TemplateValue;
+        inject?: Record<string, string>;
+        doLog?: boolean;
+    };
+}
+export interface FnJoinNow {
+    'Fn::JoinNow': [string, TemplateValue[]];
+}
+export interface FnSubNow {
+    'Fn::SubNow': string | [string, Record<string, TemplateValue>];
+}
+export interface FnRefNow {
+    'Fn::RefNow': string | {
+        Ref?: string;
+        ref?: string;
+        returnType?: 'arn' | 'name';
+    };
+}
+export interface FnApplyTags {
+    'Fn::ApplyTags': {
+        tags?: TemplateValue[];
+        Tags?: TemplateValue[];
+        resources: Record<string, Resource>;
+    };
+}
+export interface FnBase64 {
+    'Fn::Base64': TemplateValue;
+}
+export interface FnFindInMap {
+    'Fn::FindInMap': [string | TemplateValue, string | TemplateValue, string | TemplateValue];
+}
+export interface FnGetAtt {
+    'Fn::GetAtt': [string, string] | string;
+}
+export interface FnGetAZs {
+    'Fn::GetAZs': string | TemplateValue;
+}
+export interface FnImportValue {
+    'Fn::ImportValue': TemplateValue;
+}
+export interface FnJoin {
+    'Fn::Join': [string, TemplateValue[]];
+}
+export interface FnSelect {
+    'Fn::Select': [number | TemplateValue, TemplateValue[]];
+}
+export interface FnSub {
+    'Fn::Sub': string | [string, Record<string, TemplateValue>];
+}
+export interface FnSplit {
+    'Fn::Split': [string, TemplateValue];
+}
+export interface FnRef {
+    Ref: string;
+}
+export interface FnCidr {
+    'Fn::Cidr': [TemplateValue, number | TemplateValue, number | TemplateValue];
+}
+export interface FnGetParam {
+    'Fn::GetParam': [string, string, string];
+}
+export interface FnAnd {
+    'Fn::And': TemplateValue[];
+}
+export interface FnEquals {
+    'Fn::Equals': [TemplateValue, TemplateValue];
+}
+export interface FnIf {
+    'Fn::If': [string, TemplateValue, TemplateValue];
+}
+export interface FnNot {
+    'Fn::Not': [TemplateValue];
+}
+export interface FnOr {
+    'Fn::Or': TemplateValue[];
+}
+export interface Condition {
+    Condition: string;
+}
+//# sourceMappingURL=template.d.ts.map

package/dist/types/template.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"template.d.ts","sourceRoot":"","sources":["../../src/types/template.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,GACT,aAAa,EAAE,GACf,cAAc,GACd,iBAAiB,CAAC;AAEtB;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,wBAAwB,CAAC,EAAE,YAAY,CAAC;IACxC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IACzE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC/C,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,UAAU,CAAC,EAAE;QACX,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC9B,cAAc,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC;IAClD,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,mBAAmB,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC;IACvD,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,aAAa,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,aAAa,CAAC;KACrB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,SAAS,GACT,KAAK,GACL,OAAO,GACP,WAAW,GACX,SAAS,GACT,aAAa,GACb,MAAM,GACN,SAAS,GACT,QAAQ,GACR,MAAM,GACN,YAAY,GACZ,QAAQ,GACR,YAAY,GACZ,SAAS,GACT,MAAM,GACN,WAAW,GACX,QAAQ,GACR,WAAW,GACX,aAAa,GACb,YAAY,GACZ,cAAc,GACd,WAAW,GACX,UAAU,GACV,SAAS,GACT,QAAQ,GACR,gBAAgB,GAChB,gBAAgB,GAChB,MAAM,GACN,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,WAAW,GAEX,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,QAAQ,GACR,aAAa,GACb,MAAM,GACN,QAAQ,GACR,KAAK,GACL,OAAO,GACP,KAAK,GACL,MAAM,GACN,UAAU,GACV,KAAK,GACL,QAAQ,GACR,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,SAAS,CAAC;AAGd,MAAM,WAAW,SAAS;IACxB,aAAa,EAAE,MAAM,GAAG,gBAAgB,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;CACvE;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IACrC,KAAK,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;IAC/B,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,KAAK;IACpB,SAAS,EAAE,CAAC,aAAa,EAAE,aAAa,CAAC,GAAG,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,aAAa,CAAC,CAAC;CAC/F;AAED,MAAM,WAAW,OAAO;IACtB,WAAW,EAAE,aAAa,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,WAAW;IAC1B,eAAe,EAAE,aAAa,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,SAAS;IACxB,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED,MAAM,WAAW,aAAa;IAC5B,iBAAiB,EAAE,aAAa,CAAC;CAClC;AAED,MAAM,WAAW,MAAM;IACrB,UAAU,EAAE,aAAa,CAAC;CAC3B;AAED,MAAM,WAAW,SAAS;IACxB,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED,MAAM,WAAW,QAAQ;IACvB,YAAY,EAAE,aAAa,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,MAAM;IACrB,UAAU,EAAE,aAAa,CAAC;CAC3B;AAED,MAAM,WAAW,YAAY;IAC3B,gBAAgB,EAAE,aAAa,CAAC;CACjC;AAED,MAAM,WAAW,QAAQ;IACvB,YAAY,EAAE;QAAE,IAAI,EAAE,aAAa,CAAC;QAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,CAAC;CACrE;AAED,MAAM,WAAW,YAAY;IAC3B,gBAAgB,EAAE;QAAE,MAAM,CAAC,EAAE,aAAa,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,GAAG,aAAa,CAAC;CACjG;AAED,MAAM,WAAW,SAAS;IACxB,aAAa,EAAE,CAAC,aAAa,EAAE,EAAE,aAAa,EAAE,CAAC,GAAG;QAAE,IAAI,EAAE,aAAa,EAAE,CAAC;QAAC,QAAQ,EAAE,aAAa,EAAE,CAAA;KAAE,CAAC;CAC1G;AAED,MAAM,WAAW,MAAM;IACrB,UAAU,EAAE,CAAC,cAAc,EAAE,MAAM,EAAE,CAAC,GAAG;QAAE,MAAM,EAAE,cAAc,CAAC;QAAC,KAAK,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;CACtF;AAED,MAAM,WAAW,WAAW;IAC1B,eAAe,EAAE,cAAc,CAAC;CACjC;AAED,MAAM,WAAW,QAAQ;IACvB,YAAY,EAAE,aAAa,CAAC;CAC7B;AAED,MAAM,WAAW,WAAW;IAC1B,eAAe,EAAE,aAAa,CAAC;CAChC;AAED,MAAM,WAAW,aAAa;IAC5B,iBAAiB,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;CAC5E;AAED,MAAM,WAAW,YAAY;IAC3B,gBAAgB,EAAE,aAAa,CAAC;CACjC;AAED,MAAM,WAAW,cAAc;IAC7B,kBAAkB,EAAE,aAAa,CAAC;CACnC;AAED,MAAM,WAAW,WAAW;IAC1B,eAAe,EAAE,MAAM,GAAG;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;CAC1F;AAED,MAAM,WAAW,UAAU;IACzB,cAAc,EAAE,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CAC7D;AAED,MAAM,WAAW,SAAS;IACxB,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,QAAQ;IACvB,YAAY,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;CAChD;AAED,MAAM,WAAW,gBAAgB;IAC/B,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,gBAAgB;IAC/B,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,MAAM;IACrB,UAAU,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;CACnG;AAED,MAAM,WAAW,QAAQ;IACvB,YAAY,EAAE;QACZ,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,aAAa,CAAC;QACvB,KAAK,CAAC,EAAE,aAAa,CAAC;QACtB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChC,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB,CAAC;CACH;AAED,MAAM,WAAW,SAAS;IACxB,aAAa,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,QAAQ;IACvB,YAAY,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;CAChE;AAED,MAAM,WAAW,QAAQ;IACvB,YAAY,EAAE,MAAM,GAAG;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;KAAE,CAAC;CACpF;AAED,MAAM,WAAW,WAAW;IAC1B,eAAe,EAAE;QAAE,IAAI,CAAC,EAAE,aAAa,EAAE,CAAC;QAAC,IAAI,CAAC,EAAE,aAAa,EAAE,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;KAAE,CAAC;CAC1G;AAGD,MAAM,WAAW,QAAQ;IACvB,YAAY,EAAE,aAAa,CAAC;CAC7B;AAED,MAAM,WAAW,WAAW;IAC1B,eAAe,EAAE,CAAC,MAAM,GAAG,aAAa,EAAE,MAAM,GAAG,aAAa,EAAE,MAAM,GAAG,aAAa,CAAC,CAAC;CAC3F;AAED,MAAM,WAAW,QAAQ;IACvB,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC;CACzC;AAED,MAAM,WAAW,QAAQ;IACvB,YAAY,EAAE,MAAM,GAAG,aAAa,CAAC;CACtC;AAED,MAAM,WAAW,aAAa;IAC5B,iBAAiB,EAAE,aAAa,CAAC;CAClC;AAED,MAAM,WAAW,MAAM;IACrB,UAAU,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,QAAQ;IACvB,YAAY,EAAE,CAAC,MAAM,GAAG,aAAa,EAAE,aAAa,EAAE,CAAC,CAAC;CACzD;AAED,MAAM,WAAW,KAAK;IACpB,SAAS,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;CAC7D;AAED,MAAM,WAAW,OAAO;IACtB,WAAW,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,KAAK;IACpB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,MAAM;IACrB,UAAU,EAAE,CAAC,aAAa,EAAE,MAAM,GAAG,aAAa,EAAE,MAAM,GAAG,aAAa,CAAC,CAAC;CAC7E;AAED,MAAM,WAAW,UAAU;IACzB,cAAc,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,KAAK;IACpB,SAAS,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,QAAQ;IACvB,YAAY,EAAE,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,IAAI;IACnB,QAAQ,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,aAAa,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,KAAK;IACpB,SAAS,EAAE,CAAC,aAAa,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,IAAI;IACnB,QAAQ,EAAE,aAAa,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAC;CACnB"}

package/dist/types/template.js

@@ -0,0 +1,5 @@
+/**
+ * CloudFormation Template Type Definitions
+ */
+export {};
+//# sourceMappingURL=template.js.map

package/dist/types/template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template.js","sourceRoot":"","sources":["../../src/types/template.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@znemz/cfn-include",
-  "version": "2.1.23",
+  "version": "4.0.0",
   "description": "Preprocessor for CloudFormation templates with support for loops and flexible include statements",
   "keywords": [
     "aws",
@@ -23,26 +23,36 @@
   },
   "type": "module",
   "exports": {
-    ".": "./index.js",
-    "./lib/*": "./lib/*"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./lib/*": {
+      "types": "./dist/lib/*.d.ts",
+      "import": "./dist/lib/*.js"
+    }
   },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "bin": {
-    "cfn-include": "bin/cli.js"
+    "cfn-include": "./dist/cli.js"
   },
   "files": [
-    "index.js",
-    "bin/",
-    "lib/"
+    "dist/"
   ],
   "scripts": {
     "better-audit": "better-npm-audit audit",
+    "build": "tsc",
+    "build:clean": "rm -rf dist && npm run build",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "prepare": "sort-package-json",
+    "prepublishOnly": "npm run build:clean",
     "serve": "serve ./t/fixtures -l 9999",
-    "test": "npm run test:this",
+    "test": "npm run build && npm run test:this",
     "test:run": "sleep 1 && mocha --timeout 20000 --bail t/include.js t/cli.js t/replaceEnv.js",
-    "test:this": "run-p -r serve test:run"
+    "test:this": "run-p -r serve test:run",
+    "typecheck": "tsc --noEmit"
   },
   "overrides": {
     "fast-xml-parser": "5.3.4"
@@ -64,6 +74,8 @@
   "devDependencies": {
     "@commitlint/cli": "^20",
     "@commitlint/config-conventional": "^20",
+    "@types/lodash": "^4.17.23",
+    "@types/node": "^25.2.2",
     "better-npm-audit": "3.11.0",
     "commit-and-tag-version": "12",
     "commitlint": "20",
@@ -75,7 +87,8 @@
     "npm-run-all": "4.1.5",
     "prettier": "3",
     "serve": "14.2.5",
-    "sort-package-json": "3.6.1"
+    "sort-package-json": "3.6.1",
+    "typescript": "^5.9.3"
   },
   "engines": {
     "node": ">=20.19"

package/bin/cli.js

@@ -1,204 +0,0 @@
-#!/usr/bin/env node
-
-import { execSync } from 'node:child_process';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { readFileSync } from 'node:fs';
-import _ from 'lodash';
-// path.parse is native in Node.js - no need for path-parse package
-
-import include from '../index.js';
-import * as yaml from '../lib/yaml.js';
-import Client from '../lib/cfnclient.js';
-import replaceEnv from '../lib/replaceEnv.js';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-// Read package.json using fs instead of import assertion
-const pkg = JSON.parse(readFileSync(path.join(__dirname, '../package.json'), 'utf8'));
-
-const { env } = process;
-
-const { default: yargs } = await import('yargs');
-const { hideBin } = await import('yargs/helpers');
-
-const opts = yargs(hideBin(process.argv))
-  .version(false)
-  .command('$0 [path] [options]', pkg.description, (y) =>
-    y.positional('path', {
-      positional: true,
-      desc: 'location of template. Either path to a local file, URL or file on an S3 bucket (e.g. s3://bucket-name/example.template)',
-      required: false,
-    }),
-  )
-  .options({
-    minimize: {
-      desc: 'minimize JSON output',
-      default: false,
-      boolean: true,
-      alias: 'm',
-    },
-    metadata: {
-      desc: 'add build metadata to output',
-      default: false,
-      boolean: true,
-    },
-    validate: {
-      desc: 'validate compiled template',
-      default: false,
-      boolean: true,
-      alias: 't',
-    },
-    yaml: {
-      desc: 'output yaml instead of json',
-      default: false,
-      boolean: true,
-      alias: 'y',
-    },
-    lineWidth: {
-      desc: 'output yaml line width',
-      default: 200,
-      number: true,
-      alias: 'l',
-    },
-    bucket: {
-      desc: 'bucket name required for templates larger than 50k',
-    },
-    context: {
-      desc: 'template full path. only utilized for stdin when the template is piped to this script',
-      required: false,
-      string: true,
-    },
-    prefix: {
-      desc: 'prefix for templates uploaded to the bucket',
-      default: 'cfn-include',
-    },
-    enable: {
-      string: true,
-      desc: `enable different options: ['env','eval'] or a combination of both via comma.`,
-      choices: ['', 'env', 'env,eval', 'eval,env', 'eval'], // '' hack
-      default: '',
-    },
-    inject: {
-      alias: 'i',
-      string: true,
-      desc: `JSON string payload to use for template injection.`,
-      coerce: (valStr) => JSON.parse(valStr),
-    },
-    doLog: {
-      boolean: true,
-      desc: `console log out include options in recurse step`,
-    },
-    'ref-now-ignore-missing': {
-      boolean: true,
-      desc: 'do not fail if Fn::RefNow reference cannot be resolved',
-    },
-    'ref-now-ignores': {
-      string: true,
-      desc: 'comma-separated list of reference names to ignore if not found',
-    },
-    version: {
-      boolean: true,
-      desc: 'print version and exit',
-      callback() {
-        console.log(pkg.version);
-        process.exit(0);
-      },
-    },
-  })
-  .parse();
-
-// make enable an array
-opts.enable = opts.enable.split(',');
-
-// Parse ref-now-ignores into an array
-const refNowIgnores = opts['ref-now-ignores'] ? opts['ref-now-ignores'].split(',').map((s) => s.trim()) : [];
-
-let promise;
-if (opts.path) {
-  let location;
-  const protocol = opts.path.match(/^\w+:\/\//);
-  if (protocol) location = opts.path;
-  else if (path.parse(opts.path).root) location = `file://${opts.path}`;
-  else location = `file://${path.join(process.cwd(), opts.path)}`;
-  promise = include({
-    url: location,
-    doEnv: opts.enable.includes('env'),
-    doEval: opts.enable.includes('eval'),
-    inject: opts.inject,
-    doLog: opts.doLog,
-    refNowIgnoreMissing: opts['ref-now-ignore-missing'],
-    refNowIgnores: refNowIgnores,
-  });
-} else {
-  promise = new Promise((resolve, reject) => {
-    process.stdin.setEncoding('utf8');
-    const rawData = [];
-    process.stdin.on('data', (chunk) => rawData.push(chunk));
-    process.stdin.on('error', (err) => reject(err));
-    process.stdin.on('end', () => resolve(rawData.join('')));
-  }).then((template) => {
-    if (template.length === 0) {
-      console.error('empty template received from stdin');
-      process.exit(1);
-    }
-
-    const location = opts.context ? path.resolve(opts.context) : path.join(process.cwd(), 'template.yml');
-
-    template = opts.enable.includes('env') ? replaceEnv(template) : template;
-
-    return include({
-      template: yaml.load(template),
-      url: `file://${location}`,
-      doEnv: opts.enable.includes('env'),
-      doEval: opts.enable.includes('eval'),
-      inject: opts.inject,
-      doLog: opts.doLog,
-      refNowIgnoreMissing: opts['ref-now-ignore-missing'],
-      refNowIgnores: refNowIgnores,
-    }).catch((err) => console.error(err));
-  });
-}
-
-promise
-  .then(function (template) {
-    if (opts.metadata) {
-      let stdout;
-      try {
-        stdout = execSync('git log -n 1 --pretty=%H', {
-          stdio: [0, 'pipe', 'ignore'],
-        })
-          .toString()
-          .trim();
-      } catch {
-        // ignore git errors
-      }
-      _.defaultsDeep(template, {
-        Metadata: {
-          CfnInclude: {
-            GitCommit: stdout,
-            BuildDate: new Date().toISOString(),
-          },
-        },
-      });
-    }
-    if (opts.validate) {
-      const cfn = new Client({
-        region: env.AWS_REGION || env.AWS_DEFAULT_REGION || 'us-east-1',
-        bucket: opts.bucket,
-        prefix: opts.prefix,
-      });
-      return cfn.validateTemplate(JSON.stringify(template)).then(() => template);
-    }
-    return template;
-  })
-  .then((template) => {
-    console.log(opts.yaml ? yaml.dump(template, opts) : JSON.stringify(template, null, opts.minimize ? null : 2));
-  })
-  .catch(function (err) {
-    if (typeof err.toString === 'function') console.error(err.toString());
-    else console.error(err);
-    console.log(err.stack);
-    process.exit(1);
-  });