@lightdash/common 0.2687.0 → 0.2688.0

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.
Files changed (13) hide show
  1. package/dist/cjs/.tsbuildinfo +1 -1
  2. package/dist/cjs/schemas/json/dashboard-as-code-1.0.json +30 -0
  3. package/dist/cjs/types/coder.d.ts +1 -1
  4. package/dist/cjs/types/coder.d.ts.map +1 -1
  5. package/dist/esm/.tsbuildinfo +1 -1
  6. package/dist/esm/schemas/json/dashboard-as-code-1.0.json +30 -0
  7. package/dist/esm/types/coder.d.ts +1 -1
  8. package/dist/esm/types/coder.d.ts.map +1 -1
  9. package/dist/types/.tsbuildinfo +1 -1
  10. package/dist/types/schemas/json/dashboard-as-code-1.0.json +30 -0
  11. package/dist/types/types/coder.d.ts +1 -1
  12. package/dist/types/types/coder.d.ts.map +1 -1
  13. package/package.json +1 -1
package/dist/esm/schemas/json/dashboard-as-code-1.0.json CHANGED
@@ -467,6 +467,36 @@
467
467
  }
468
468
  }
469
469
  },
470
+ "parameters": {
471
+ "type": "object",
472
+ "description": "Dashboard parameter values that override default parameter values defined in the dbt project. Keys are parameter identifiers, values contain the parameter name and its override value.",
473
+ "additionalProperties": {
474
+ "type": "object",
475
+ "required": ["parameterName", "value"],
476
+ "additionalProperties": false,
477
+ "properties": {
478
+ "parameterName": {
479
+ "type": "string",
480
+ "description": "Name of the parameter as defined in the dbt project"
481
+ },
482
+ "value": {
483
+ "description": "Override value for the parameter",
484
+ "oneOf": [
485
+ { "type": "string" },
486
+ { "type": "number" },
487
+ {
488
+ "type": "array",
489
+ "items": { "type": "string" }
490
+ },
491
+ {
492
+ "type": "array",
493
+ "items": { "type": "number" }
494
+ }
495
+ ]
496
+ }
497
+ }
498
+ }
499
+ },
470
500
  "config": {
471
501
  "type": "object",
472
502
  "description": "Dashboard configuration settings such as date zoom behavior",
package/dist/esm/types/coder.d.ts CHANGED
@@ -100,7 +100,7 @@ export type DashboardTileAsCode = Omit<DashboardTile, 'properties' | 'uuid'> & {
100
100
  export type DashboardTileWithSlug = DashboardTile & {
101
101
  tileSlug: string | undefined;
102
102
  };
103
- export type DashboardAsCode = Pick<Dashboard, 'name' | 'description' | 'tabs' | 'slug' | 'config'> & {
103
+ export type DashboardAsCode = Pick<Dashboard, 'name' | 'description' | 'tabs' | 'slug' | 'config' | 'parameters'> & {
104
104
  /** Not modifiable by user, but useful to know if it has been updated. Defaults to now if omitted. */
105
105
  updatedAt?: Date;
106
106
  tiles: DashboardTileAsCode[];
package/dist/esm/types/coder.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"coder.d.ts","sourceRoot":"","sources":["../../../src/types/coder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,KAAK,EACR,sBAAsB,EACtB,SAAS,EACT,0BAA0B,EAC1B,4BAA4B,EAC5B,mBAAmB,EACnB,8BAA8B,EAC9B,2BAA2B,EAC3B,+BAA+B,EAC/B,aAAa,EACb,UAAU,EACV,WAAW,EACX,gBAAgB,EAChB,UAAU,EACV,QAAQ,EACX,MAAM,IAAI,CAAC;AACZ,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAErE,eAAO,MAAM,cAAc,IAAI,CAAC;AAEhC,oBAAY,iBAAiB;IACzB,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,SAAS,cAAc;IACvB,KAAK,UAAU;CAClB;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,GAAG;IAAE,EAAE,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AACvE,MAAM,MAAM,kBAAkB,GAAG;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;CACnC,CAAC;AACF,MAAM,MAAM,mBAAmB,GAAG;IAC9B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;CACpC,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG,kBAAkB,GAAG,mBAAmB,CAAC;AACxE,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG,eAAe,CAAC;AACtE,MAAM,MAAM,YAAY,GAAG;IACvB,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,iBAAiB,CAAC,EAAE,gBAAgB,CAAC;CACxC,CAAC;AAKF,MAAM,MAAM,WAAW,GAAG,IAAI,CAC1B,IAAI,CACA,UAAU,EACR,MAAM,GACN,aAAa,GACb,WAAW,GACX,aAAa,GACb,aAAa,GACb,aAAa,GACb,MAAM,GACN,YAAY,CACjB,EACD,aAAa,CAChB,GAAG;IACA,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG;QAAE,OAAO,EAAE,YAAY,CAAA;KAAE,CAAC;IACtE,qGAAqG;IACrG,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,sEAAsE;IACtE,WAAW,CAAC,EAAE;QAAE,WAAW,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IACxC,2DAA2D;IAC3D,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,WAAW,CAAC,EAAE,iBAAiB,CAAC,KAAK,CAAC;IACtC,8CAA8C;IAC9C,SAAS,EAAE,MAAM,CAAC;IAClB,8DAA8D;IAC9D,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,uEAAuE;IACvE,YAAY,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;CACjD,CAAC;AAIF,MAAM,MAAM,cAAc,GAAG,IAAI,CAC7B,QAAQ,EACR,MAAM,GAAG,aAAa,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,WAAW,CAC7E,GAAG;IACA,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,iBAAiB,CAAC,SAAS,CAAC;IAC1C,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,YAAY,CAAC,EAAE,IAAI,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACrC,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE;QACL,MAAM,EAAE,WAAW,EAAE,CAAC;QACtB,WAAW,EACL,KAAK,CACC,WAAW,CACP,sBAAsB,EACtB;YAAE,iBAAiB,EAAE,IAAI,CAAA;SAAE,CAC9B,GACD,SAAS,CACd,GACD,SAAS,CAAC;QAChB,UAAU,EAAE,MAAM,EAAE,CAAC;QACrB,MAAM,EAAE,WAAW,EAAE,CAAC;QACtB,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC;CACL,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACvC,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE,gBAAgB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC1C,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE,gBAAgB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IACxC,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE;QACL,SAAS,EAAE,cAAc,EAAE,CAAC;QAC5B,UAAU,EAAE,MAAM,EAAE,CAAC;QACrB,MAAM,EAAE,WAAW,EAAE,CAAC;QACtB,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC;CACL,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,aAAa,EAAE,YAAY,GAAG,MAAM,CAAC,GAAG;IAC3E,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACxC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,UAAU,EACJ,IAAI,CACA,4BAA4B,CAAC,YAAY,CAAC,EAC1C,OAAO,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,CACpD,GACD,+BAA+B,CAAC,YAAY,CAAC,GAC7C,2BAA2B,CAAC,YAAY,CAAC,GACzC,8BAA8B,CAAC,YAAY,CAAC,CAAC;CACtD,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,aAAa,GAAG;IAChD,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,IAAI,CAC9B,SAAS,EACT,MAAM,GAAG,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,CACtD,GAAG;IACA,qGAAqG;IACrG,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,KAAK,EAAE,mBAAmB,EAAE,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,iBAAiB,CAAC,SAAS,CAAC;IAC1C,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,OAAO,CAAC,EAAE;QACN,UAAU,CAAC,EAAE,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC;QAC/C,OAAO,CAAC,EAAE,mBAAmB,EAAE,CAAC;QAChC,iBAAiB,CAAC,EAAE,mBAAmB,EAAE,CAAC;KAC7C,CAAC;IACF,2EAA2E;IAC3E,YAAY,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;CACjD,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACtB,WAAW,EAAE,iBAAiB,CAAC,KAAK,CAAC;IACrC,6EAA6E;IAC7E,SAAS,EAAE,MAAM,CAAC;IAClB,gEAAgE;IAChE,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IACzC,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE;QACL,UAAU,EAAE,eAAe,EAAE,CAAC;QAC9B,WAAW,EACL,KAAK,CACC,WAAW,CACP,0BAA0B,EAC1B;YAAE,iBAAiB,EAAE,IAAI,CAAA;SAAE,CAC9B,GACD,SAAS,CACd,GACD,SAAS,CAAC;QAChB,UAAU,EAAE,MAAM,EAAE,CAAC;QACrB,MAAM,EAAE,WAAW,EAAE,CAAC;QACtB,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC;CACL,CAAC;AACF,MAAM,MAAM,gCAAgC,GAAG;IAC3C,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE,gBAAgB,CAAC;CAC7B,CAAC"}
1
+ {"version":3,"file":"coder.d.ts","sourceRoot":"","sources":["../../../src/types/coder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,KAAK,EACR,sBAAsB,EACtB,SAAS,EACT,0BAA0B,EAC1B,4BAA4B,EAC5B,mBAAmB,EACnB,8BAA8B,EAC9B,2BAA2B,EAC3B,+BAA+B,EAC/B,aAAa,EACb,UAAU,EACV,WAAW,EACX,gBAAgB,EAChB,UAAU,EACV,QAAQ,EACX,MAAM,IAAI,CAAC;AACZ,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAErE,eAAO,MAAM,cAAc,IAAI,CAAC;AAEhC,oBAAY,iBAAiB;IACzB,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,SAAS,cAAc;IACvB,KAAK,UAAU;CAClB;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,GAAG;IAAE,EAAE,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AACvE,MAAM,MAAM,kBAAkB,GAAG;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;CACnC,CAAC;AACF,MAAM,MAAM,mBAAmB,GAAG;IAC9B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;CACpC,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG,kBAAkB,GAAG,mBAAmB,CAAC;AACxE,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG,eAAe,CAAC;AACtE,MAAM,MAAM,YAAY,GAAG;IACvB,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,iBAAiB,CAAC,EAAE,gBAAgB,CAAC;CACxC,CAAC;AAKF,MAAM,MAAM,WAAW,GAAG,IAAI,CAC1B,IAAI,CACA,UAAU,EACR,MAAM,GACN,aAAa,GACb,WAAW,GACX,aAAa,GACb,aAAa,GACb,aAAa,GACb,MAAM,GACN,YAAY,CACjB,EACD,aAAa,CAChB,GAAG;IACA,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG;QAAE,OAAO,EAAE,YAAY,CAAA;KAAE,CAAC;IACtE,qGAAqG;IACrG,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,sEAAsE;IACtE,WAAW,CAAC,EAAE;QAAE,WAAW,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IACxC,2DAA2D;IAC3D,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,WAAW,CAAC,EAAE,iBAAiB,CAAC,KAAK,CAAC;IACtC,8CAA8C;IAC9C,SAAS,EAAE,MAAM,CAAC;IAClB,8DAA8D;IAC9D,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,uEAAuE;IACvE,YAAY,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;CACjD,CAAC;AAIF,MAAM,MAAM,cAAc,GAAG,IAAI,CAC7B,QAAQ,EACR,MAAM,GAAG,aAAa,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,WAAW,CAC7E,GAAG;IACA,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,iBAAiB,CAAC,SAAS,CAAC;IAC1C,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,YAAY,CAAC,EAAE,IAAI,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACrC,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE;QACL,MAAM,EAAE,WAAW,EAAE,CAAC;QACtB,WAAW,EACL,KAAK,CACC,WAAW,CACP,sBAAsB,EACtB;YAAE,iBAAiB,EAAE,IAAI,CAAA;SAAE,CAC9B,GACD,SAAS,CACd,GACD,SAAS,CAAC;QAChB,UAAU,EAAE,MAAM,EAAE,CAAC;QACrB,MAAM,EAAE,WAAW,EAAE,CAAC;QACtB,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC;CACL,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACvC,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE,gBAAgB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC1C,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE,gBAAgB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IACxC,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE;QACL,SAAS,EAAE,cAAc,EAAE,CAAC;QAC5B,UAAU,EAAE,MAAM,EAAE,CAAC;QACrB,MAAM,EAAE,WAAW,EAAE,CAAC;QACtB,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC;CACL,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,aAAa,EAAE,YAAY,GAAG,MAAM,CAAC,GAAG;IAC3E,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACxC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,UAAU,EACJ,IAAI,CACA,4BAA4B,CAAC,YAAY,CAAC,EAC1C,OAAO,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,CACpD,GACD,+BAA+B,CAAC,YAAY,CAAC,GAC7C,2BAA2B,CAAC,YAAY,CAAC,GACzC,8BAA8B,CAAC,YAAY,CAAC,CAAC;CACtD,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,aAAa,GAAG;IAChD,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,IAAI,CAC9B,SAAS,EACT,MAAM,GAAG,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,YAAY,CACrE,GAAG;IACA,qGAAqG;IACrG,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,KAAK,EAAE,mBAAmB,EAAE,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,iBAAiB,CAAC,SAAS,CAAC;IAC1C,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,OAAO,CAAC,EAAE;QACN,UAAU,CAAC,EAAE,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC;QAC/C,OAAO,CAAC,EAAE,mBAAmB,EAAE,CAAC;QAChC,iBAAiB,CAAC,EAAE,mBAAmB,EAAE,CAAC;KAC7C,CAAC;IACF,2EAA2E;IAC3E,YAAY,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;CACjD,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACtB,WAAW,EAAE,iBAAiB,CAAC,KAAK,CAAC;IACrC,6EAA6E;IAC7E,SAAS,EAAE,MAAM,CAAC;IAClB,gEAAgE;IAChE,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IACzC,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE;QACL,UAAU,EAAE,eAAe,EAAE,CAAC;QAC9B,WAAW,EACL,KAAK,CACC,WAAW,CACP,0BAA0B,EAC1B;YAAE,iBAAiB,EAAE,IAAI,CAAA;SAAE,CAC9B,GACD,SAAS,CACd,GACD,SAAS,CAAC;QAChB,UAAU,EAAE,MAAM,EAAE,CAAC;QACrB,MAAM,EAAE,WAAW,EAAE,CAAC;QACtB,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC;CACL,CAAC;AACF,MAAM,MAAM,gCAAgC,GAAG;IAC3C,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE,gBAAgB,CAAC;CAC7B,CAAC"}