@dataform/core 3.0.35 → 3.0.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/bundle.d.ts CHANGED
@@ -2,8 +2,6 @@ import * as $protobuf from 'protobufjs';
2
2
 
3
3
  declare function compile(code: string, path: string): string;
4
4
 
5
- declare function main(coreExecutionRequest: Uint8Array | string): Uint8Array | string;
6
-
7
5
  /** Namespace dataform. */
8
6
  namespace dataform {
9
7
 
@@ -45,6 +43,9 @@ namespace dataform {
45
43
 
46
44
  /** WorkflowSettings defaultIcebergConfig */
47
45
  defaultIcebergConfig?: (dataform.IDefaultIcebergConfig|null);
46
+
47
+ /** WorkflowSettings disableAssertions */
48
+ disableAssertions?: (boolean|null);
48
49
  }
49
50
 
50
51
  /** Represents a WorkflowSettings. */
@@ -92,6 +93,9 @@ namespace dataform {
92
93
  /** WorkflowSettings defaultIcebergConfig. */
93
94
  public defaultIcebergConfig?: (dataform.IDefaultIcebergConfig|null);
94
95
 
96
+ /** WorkflowSettings disableAssertions. */
97
+ public disableAssertions: boolean;
98
+
95
99
  /**
96
100
  * Creates a new WorkflowSettings instance using the specified properties.
97
101
  * @param [properties] Properties to set
@@ -1166,6 +1170,9 @@ namespace dataform {
1166
1170
 
1167
1171
  /** TableConfig iceberg */
1168
1172
  iceberg?: (dataform.ActionConfig.IIcebergTableConfig|null);
1173
+
1174
+ /** TableConfig metadata */
1175
+ metadata?: (dataform.ActionConfig.IMetadata|null);
1169
1176
  }
1170
1177
 
1171
1178
  /** Represents a TableConfig. */
@@ -1240,6 +1247,9 @@ namespace dataform {
1240
1247
  /** TableConfig iceberg. */
1241
1248
  public iceberg?: (dataform.ActionConfig.IIcebergTableConfig|null);
1242
1249
 
1250
+ /** TableConfig metadata. */
1251
+ public metadata?: (dataform.ActionConfig.IMetadata|null);
1252
+
1243
1253
  /**
1244
1254
  * Creates a new TableConfig instance using the specified properties.
1245
1255
  * @param [properties] Properties to set
@@ -1318,6 +1328,103 @@ namespace dataform {
1318
1328
  public static getTypeUrl(typeUrlPrefix?: string): string;
1319
1329
  }
1320
1330
 
1331
+ /** Properties of a Metadata. */
1332
+ interface IMetadata {
1333
+
1334
+ /** Metadata overview */
1335
+ overview?: (string|null);
1336
+ }
1337
+
1338
+ /** Represents a Metadata. */
1339
+ class Metadata implements IMetadata {
1340
+
1341
+ /**
1342
+ * Constructs a new Metadata.
1343
+ * @param [properties] Properties to set
1344
+ */
1345
+ constructor(properties?: dataform.ActionConfig.IMetadata);
1346
+
1347
+ /** Metadata overview. */
1348
+ public overview: string;
1349
+
1350
+ /**
1351
+ * Creates a new Metadata instance using the specified properties.
1352
+ * @param [properties] Properties to set
1353
+ * @returns Metadata instance
1354
+ */
1355
+ public static create(properties?: dataform.ActionConfig.IMetadata): dataform.ActionConfig.Metadata;
1356
+
1357
+ /**
1358
+ * Encodes the specified Metadata message. Does not implicitly {@link dataform.ActionConfig.Metadata.verify|verify} messages.
1359
+ * @param message Metadata message or plain object to encode
1360
+ * @param [writer] Writer to encode to
1361
+ * @returns Writer
1362
+ */
1363
+ public static encode(message: dataform.ActionConfig.IMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
1364
+
1365
+ /**
1366
+ * Encodes the specified Metadata message, length delimited. Does not implicitly {@link dataform.ActionConfig.Metadata.verify|verify} messages.
1367
+ * @param message Metadata message or plain object to encode
1368
+ * @param [writer] Writer to encode to
1369
+ * @returns Writer
1370
+ */
1371
+ public static encodeDelimited(message: dataform.ActionConfig.IMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
1372
+
1373
+ /**
1374
+ * Decodes a Metadata message from the specified reader or buffer.
1375
+ * @param reader Reader or buffer to decode from
1376
+ * @param [length] Message length if known beforehand
1377
+ * @returns Metadata
1378
+ * @throws {Error} If the payload is not a reader or valid buffer
1379
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
1380
+ */
1381
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): dataform.ActionConfig.Metadata;
1382
+
1383
+ /**
1384
+ * Decodes a Metadata message from the specified reader or buffer, length delimited.
1385
+ * @param reader Reader or buffer to decode from
1386
+ * @returns Metadata
1387
+ * @throws {Error} If the payload is not a reader or valid buffer
1388
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
1389
+ */
1390
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): dataform.ActionConfig.Metadata;
1391
+
1392
+ /**
1393
+ * Verifies a Metadata message.
1394
+ * @param message Plain object to verify
1395
+ * @returns `null` if valid, otherwise the reason why it is not
1396
+ */
1397
+ public static verify(message: { [k: string]: any }): (string|null);
1398
+
1399
+ /**
1400
+ * Creates a Metadata message from a plain object. Also converts values to their respective internal types.
1401
+ * @param object Plain object
1402
+ * @returns Metadata
1403
+ */
1404
+ public static fromObject(object: { [k: string]: any }): dataform.ActionConfig.Metadata;
1405
+
1406
+ /**
1407
+ * Creates a plain object from a Metadata message. Also converts values to other types if specified.
1408
+ * @param message Metadata
1409
+ * @param [options] Conversion options
1410
+ * @returns Plain object
1411
+ */
1412
+ public static toObject(message: dataform.ActionConfig.Metadata, options?: $protobuf.IConversionOptions): { [k: string]: any };
1413
+
1414
+ /**
1415
+ * Converts this Metadata to JSON.
1416
+ * @returns JSON object
1417
+ */
1418
+ public toJSON(): { [k: string]: any };
1419
+
1420
+ /**
1421
+ * Gets the default type url for Metadata
1422
+ * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
1423
+ * @returns The default type url
1424
+ */
1425
+ public static getTypeUrl(typeUrlPrefix?: string): string;
1426
+ }
1427
+
1321
1428
  /** Properties of a ViewConfig. */
1322
1429
  interface IViewConfig {
1323
1430
 
@@ -1377,6 +1484,9 @@ namespace dataform {
1377
1484
 
1378
1485
  /** ViewConfig assertions */
1379
1486
  assertions?: (dataform.ActionConfig.ITableAssertionsConfig|null);
1487
+
1488
+ /** ViewConfig metadata */
1489
+ metadata?: (dataform.ActionConfig.IMetadata|null);
1380
1490
  }
1381
1491
 
1382
1492
  /** Represents a ViewConfig. */
@@ -1445,6 +1555,9 @@ namespace dataform {
1445
1555
  /** ViewConfig assertions. */
1446
1556
  public assertions?: (dataform.ActionConfig.ITableAssertionsConfig|null);
1447
1557
 
1558
+ /** ViewConfig metadata. */
1559
+ public metadata?: (dataform.ActionConfig.IMetadata|null);
1560
+
1448
1561
  /**
1449
1562
  * Creates a new ViewConfig instance using the specified properties.
1450
1563
  * @param [properties] Properties to set
@@ -1608,6 +1721,9 @@ namespace dataform {
1608
1721
 
1609
1722
  /** IncrementalTableConfig iceberg */
1610
1723
  iceberg?: (dataform.ActionConfig.IIcebergTableConfig|null);
1724
+
1725
+ /** IncrementalTableConfig metadata */
1726
+ metadata?: (dataform.ActionConfig.IMetadata|null);
1611
1727
  }
1612
1728
 
1613
1729
  /** Represents an IncrementalTableConfig. */
@@ -1694,6 +1810,9 @@ namespace dataform {
1694
1810
  /** IncrementalTableConfig iceberg. */
1695
1811
  public iceberg?: (dataform.ActionConfig.IIcebergTableConfig|null);
1696
1812
 
1813
+ /** IncrementalTableConfig metadata. */
1814
+ public metadata?: (dataform.ActionConfig.IMetadata|null);
1815
+
1697
1816
  /**
1698
1817
  * Creates a new IncrementalTableConfig instance using the specified properties.
1699
1818
  * @param [properties] Properties to set
@@ -2884,6 +3003,9 @@ namespace dataform {
2884
3003
 
2885
3004
  /** ProjectConfig defaultIcebergConfig */
2886
3005
  defaultIcebergConfig?: (dataform.IDefaultIcebergConfig|null);
3006
+
3007
+ /** ProjectConfig disableAssertions */
3008
+ disableAssertions?: (boolean|null);
2887
3009
  }
2888
3010
 
2889
3011
  /** Represents a ProjectConfig. */
@@ -2931,6 +3053,9 @@ namespace dataform {
2931
3053
  /** ProjectConfig defaultIcebergConfig. */
2932
3054
  public defaultIcebergConfig?: (dataform.IDefaultIcebergConfig|null);
2933
3055
 
3056
+ /** ProjectConfig disableAssertions. */
3057
+ public disableAssertions: boolean;
3058
+
2934
3059
  /**
2935
3060
  * Creates a new ProjectConfig instance using the specified properties.
2936
3061
  * @param [properties] Properties to set
@@ -3023,6 +3148,9 @@ namespace dataform {
3023
3148
 
3024
3149
  /** CompileConfig timeoutMillis */
3025
3150
  timeoutMillis?: (number|null);
3151
+
3152
+ /** CompileConfig extension */
3153
+ extension?: (dataform.IExtension|null);
3026
3154
  }
3027
3155
 
3028
3156
  /** Represents a CompileConfig. */
@@ -3046,6 +3174,9 @@ namespace dataform {
3046
3174
  /** CompileConfig timeoutMillis. */
3047
3175
  public timeoutMillis: number;
3048
3176
 
3177
+ /** CompileConfig extension. */
3178
+ public extension?: (dataform.IExtension|null);
3179
+
3049
3180
  /**
3050
3181
  * Creates a new CompileConfig instance using the specified properties.
3051
3182
  * @param [properties] Properties to set
@@ -3637,6 +3768,9 @@ namespace dataform {
3637
3768
 
3638
3769
  /** ActionDescriptor bigqueryLabels */
3639
3770
  bigqueryLabels?: ({ [k: string]: string }|null);
3771
+
3772
+ /** ActionDescriptor metadata */
3773
+ metadata?: (dataform.IMetadata|null);
3640
3774
  }
3641
3775
 
3642
3776
  /** Represents an ActionDescriptor. */
@@ -3657,6 +3791,9 @@ namespace dataform {
3657
3791
  /** ActionDescriptor bigqueryLabels. */
3658
3792
  public bigqueryLabels: { [k: string]: string };
3659
3793
 
3794
+ /** ActionDescriptor metadata. */
3795
+ public metadata?: (dataform.IMetadata|null);
3796
+
3660
3797
  /**
3661
3798
  * Creates a new ActionDescriptor instance using the specified properties.
3662
3799
  * @param [properties] Properties to set
@@ -3735,6 +3872,103 @@ namespace dataform {
3735
3872
  public static getTypeUrl(typeUrlPrefix?: string): string;
3736
3873
  }
3737
3874
 
3875
+ /** Properties of a Metadata. */
3876
+ interface IMetadata {
3877
+
3878
+ /** Metadata overview */
3879
+ overview?: (string|null);
3880
+ }
3881
+
3882
+ /** Represents a Metadata. */
3883
+ class Metadata implements IMetadata {
3884
+
3885
+ /**
3886
+ * Constructs a new Metadata.
3887
+ * @param [properties] Properties to set
3888
+ */
3889
+ constructor(properties?: dataform.IMetadata);
3890
+
3891
+ /** Metadata overview. */
3892
+ public overview: string;
3893
+
3894
+ /**
3895
+ * Creates a new Metadata instance using the specified properties.
3896
+ * @param [properties] Properties to set
3897
+ * @returns Metadata instance
3898
+ */
3899
+ public static create(properties?: dataform.IMetadata): dataform.Metadata;
3900
+
3901
+ /**
3902
+ * Encodes the specified Metadata message. Does not implicitly {@link dataform.Metadata.verify|verify} messages.
3903
+ * @param message Metadata message or plain object to encode
3904
+ * @param [writer] Writer to encode to
3905
+ * @returns Writer
3906
+ */
3907
+ public static encode(message: dataform.IMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
3908
+
3909
+ /**
3910
+ * Encodes the specified Metadata message, length delimited. Does not implicitly {@link dataform.Metadata.verify|verify} messages.
3911
+ * @param message Metadata message or plain object to encode
3912
+ * @param [writer] Writer to encode to
3913
+ * @returns Writer
3914
+ */
3915
+ public static encodeDelimited(message: dataform.IMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
3916
+
3917
+ /**
3918
+ * Decodes a Metadata message from the specified reader or buffer.
3919
+ * @param reader Reader or buffer to decode from
3920
+ * @param [length] Message length if known beforehand
3921
+ * @returns Metadata
3922
+ * @throws {Error} If the payload is not a reader or valid buffer
3923
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
3924
+ */
3925
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): dataform.Metadata;
3926
+
3927
+ /**
3928
+ * Decodes a Metadata message from the specified reader or buffer, length delimited.
3929
+ * @param reader Reader or buffer to decode from
3930
+ * @returns Metadata
3931
+ * @throws {Error} If the payload is not a reader or valid buffer
3932
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
3933
+ */
3934
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): dataform.Metadata;
3935
+
3936
+ /**
3937
+ * Verifies a Metadata message.
3938
+ * @param message Plain object to verify
3939
+ * @returns `null` if valid, otherwise the reason why it is not
3940
+ */
3941
+ public static verify(message: { [k: string]: any }): (string|null);
3942
+
3943
+ /**
3944
+ * Creates a Metadata message from a plain object. Also converts values to their respective internal types.
3945
+ * @param object Plain object
3946
+ * @returns Metadata
3947
+ */
3948
+ public static fromObject(object: { [k: string]: any }): dataform.Metadata;
3949
+
3950
+ /**
3951
+ * Creates a plain object from a Metadata message. Also converts values to other types if specified.
3952
+ * @param message Metadata
3953
+ * @param [options] Conversion options
3954
+ * @returns Plain object
3955
+ */
3956
+ public static toObject(message: dataform.Metadata, options?: $protobuf.IConversionOptions): { [k: string]: any };
3957
+
3958
+ /**
3959
+ * Converts this Metadata to JSON.
3960
+ * @returns JSON object
3961
+ */
3962
+ public toJSON(): { [k: string]: any };
3963
+
3964
+ /**
3965
+ * Gets the default type url for Metadata
3966
+ * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
3967
+ * @returns The default type url
3968
+ */
3969
+ public static getTypeUrl(typeUrlPrefix?: string): string;
3970
+ }
3971
+
3738
3972
  /** Properties of a ColumnDescriptor. */
3739
3973
  interface IColumnDescriptor {
3740
3974
 
@@ -6017,6 +6251,116 @@ namespace dataform {
6017
6251
  ARRAY_BUFFER_IPC = 1
6018
6252
  }
6019
6253
 
6254
+ /** ExtensionCompilationMode enum. */
6255
+ enum ExtensionCompilationMode {
6256
+ COMPILATION_MODE_UNSPECIFIED = 0,
6257
+ PROLOGUE = 1,
6258
+ APPLICATION_CODE = 2
6259
+ }
6260
+
6261
+ /** Properties of an Extension. */
6262
+ interface IExtension {
6263
+
6264
+ /** Extension name */
6265
+ name?: (string|null);
6266
+
6267
+ /** Extension compilationMode */
6268
+ compilationMode?: (dataform.ExtensionCompilationMode|null);
6269
+ }
6270
+
6271
+ /** Represents an Extension. */
6272
+ class Extension implements IExtension {
6273
+
6274
+ /**
6275
+ * Constructs a new Extension.
6276
+ * @param [properties] Properties to set
6277
+ */
6278
+ constructor(properties?: dataform.IExtension);
6279
+
6280
+ /** Extension name. */
6281
+ public name: string;
6282
+
6283
+ /** Extension compilationMode. */
6284
+ public compilationMode: dataform.ExtensionCompilationMode;
6285
+
6286
+ /**
6287
+ * Creates a new Extension instance using the specified properties.
6288
+ * @param [properties] Properties to set
6289
+ * @returns Extension instance
6290
+ */
6291
+ public static create(properties?: dataform.IExtension): dataform.Extension;
6292
+
6293
+ /**
6294
+ * Encodes the specified Extension message. Does not implicitly {@link dataform.Extension.verify|verify} messages.
6295
+ * @param message Extension message or plain object to encode
6296
+ * @param [writer] Writer to encode to
6297
+ * @returns Writer
6298
+ */
6299
+ public static encode(message: dataform.IExtension, writer?: $protobuf.Writer): $protobuf.Writer;
6300
+
6301
+ /**
6302
+ * Encodes the specified Extension message, length delimited. Does not implicitly {@link dataform.Extension.verify|verify} messages.
6303
+ * @param message Extension message or plain object to encode
6304
+ * @param [writer] Writer to encode to
6305
+ * @returns Writer
6306
+ */
6307
+ public static encodeDelimited(message: dataform.IExtension, writer?: $protobuf.Writer): $protobuf.Writer;
6308
+
6309
+ /**
6310
+ * Decodes an Extension message from the specified reader or buffer.
6311
+ * @param reader Reader or buffer to decode from
6312
+ * @param [length] Message length if known beforehand
6313
+ * @returns Extension
6314
+ * @throws {Error} If the payload is not a reader or valid buffer
6315
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
6316
+ */
6317
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): dataform.Extension;
6318
+
6319
+ /**
6320
+ * Decodes an Extension message from the specified reader or buffer, length delimited.
6321
+ * @param reader Reader or buffer to decode from
6322
+ * @returns Extension
6323
+ * @throws {Error} If the payload is not a reader or valid buffer
6324
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
6325
+ */
6326
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): dataform.Extension;
6327
+
6328
+ /**
6329
+ * Verifies an Extension message.
6330
+ * @param message Plain object to verify
6331
+ * @returns `null` if valid, otherwise the reason why it is not
6332
+ */
6333
+ public static verify(message: { [k: string]: any }): (string|null);
6334
+
6335
+ /**
6336
+ * Creates an Extension message from a plain object. Also converts values to their respective internal types.
6337
+ * @param object Plain object
6338
+ * @returns Extension
6339
+ */
6340
+ public static fromObject(object: { [k: string]: any }): dataform.Extension;
6341
+
6342
+ /**
6343
+ * Creates a plain object from an Extension message. Also converts values to other types if specified.
6344
+ * @param message Extension
6345
+ * @param [options] Conversion options
6346
+ * @returns Plain object
6347
+ */
6348
+ public static toObject(message: dataform.Extension, options?: $protobuf.IConversionOptions): { [k: string]: any };
6349
+
6350
+ /**
6351
+ * Converts this Extension to JSON.
6352
+ * @returns JSON object
6353
+ */
6354
+ public toJSON(): { [k: string]: any };
6355
+
6356
+ /**
6357
+ * Gets the default type url for Extension
6358
+ * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
6359
+ * @returns The default type url
6360
+ */
6361
+ public static getTypeUrl(typeUrlPrefix?: string): string;
6362
+ }
6363
+
6020
6364
  /** Properties of a QueryEvaluationError. */
6021
6365
  interface IQueryEvaluationError {
6022
6366
 
@@ -8819,10 +9163,16 @@ declare class ActionMap {
8819
9163
  private setBySchemaLevel;
8820
9164
  }
8821
9165
 
8822
- declare const version = "3.0.35";
9166
+ interface IDataformExtension {
9167
+ compile(request: dataform.ICompileExecutionRequest, session: Session): void;
9168
+ }
9169
+
9170
+ declare function main(coreExecutionRequest: Uint8Array | string): Uint8Array | string;
9171
+
9172
+ declare const version = "3.0.37";
8823
9173
 
8824
9174
  declare const session: Session;
8825
9175
  declare const supportedFeatures: dataform.SupportedFeatures[];
8826
9176
  declare function indexFileGenerator(): void;
8827
9177
 
8828
- export { compile as compiler, indexFileGenerator, main, session, supportedFeatures, version };
9178
+ export { IDataformExtension, compile as compiler, indexFileGenerator, main, session, supportedFeatures, version };