@typedorm/common - npm Package Compare versions

Comparing version 1.16.0-beta.5 to 1.16.0-beta.6

cjs/src/index-options.d.ts

 import { INDEX_TYPE } from './enums';
 import { Replace } from './helpers/replace-type';
+/**
+ * When a Global Secondary Index(GSI) is created with both a partition key and a sort key, any items added * to the table that lack a partition key or sort key value will be excluded from the index.
+ * For GSIs that only have a partition key, the same behaviour applies, but only to the partition key.
+ *
+ * In these scenarios `isSparse` should be set to True.
+ */
 export interface GSIIndexOptions {
     type: INDEX_TYPE.GSI;
     partitionKey: string;
-    sortKey: string;
-    /**
-     * DynamoDB only adds item to index if both Partition Key and Sort Key defined
-     * for any given GSI contains value
-     *
-     * Indexes missing sort key value will not be added to index.
-     */
+    sortKey?: string;
     isSparse?: boolean;
@@ -14,0 +14,0 @@ }

cjs/src/index-options.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXgtb3B0aW9ucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uLy4uL3BhY2thZ2VzL2NvbW1vbi9zcmMvaW5kZXgtb3B0aW9ucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHtJTkRFWF9UWVBFfSBmcm9tICcuL2VudW1zJztcbmltcG9ydCB7UmVwbGFjZX0gZnJvbSAnLi9oZWxwZXJzL3JlcGxhY2UtdHlwZSc7XG5cbmV4cG9ydCBpbnRlcmZhY2UgR1NJSW5kZXhPcHRpb25zIHtcbiAgdHlwZTogSU5ERVhfVFlQRS5HU0k7XG4gIHBhcnRpdGlvbktleTogc3RyaW5nO1xuICBzb3J0S2V5OiBzdHJpbmc7XG4gIC8qKlxuICAgKiBEeW5hbW9EQiBvbmx5IGFkZHMgaXRlbSB0byBpbmRleCBpZiBib3RoIFBhcnRpdGlvbiBLZXkgYW5kIFNvcnQgS2V5IGRlZmluZWRcbiAgICogZm9yIGFueSBnaXZlbiBHU0kgY29udGFpbnMgdmFsdWVcbiAgICpcbiAgICogSW5kZXhlcyBtaXNzaW5nIHNvcnQga2V5IHZhbHVlIHdpbGwgbm90IGJlIGFkZGVkIHRvIGluZGV4LlxuICAgKi9cbiAgaXNTcGFyc2U/OiBib29sZWFuO1xufVxuXG5leHBvcnQgaW50ZXJmYWNlIExTSUluZGV4T3B0aW9ucyB7XG4gIHR5cGU6IElOREVYX1RZUEUuTFNJO1xuICBzb3J0S2V5OiBzdHJpbmc7XG4gIGlzU3BhcnNlPzogYm9vbGVhbjtcbn1cbmV4cG9ydCB0eXBlIEluZGV4T3B0aW9ucyA9IEdTSUluZGV4T3B0aW9ucyB8IExTSUluZGV4T3B0aW9ucztcblxuZXhwb3J0IHR5cGUgS2V5QWxpYXNTY2hlbWE8RW50aXR5PiA9IHtcbiAgYWxpYXM6IGtleW9mIEVudGl0eSBleHRlbmRzIGluZmVyIFIgPyBSIDogbmV2ZXI7XG59O1xuZXhwb3J0IHR5cGUgRW50aXR5QWxpYXNPclN0cmluZzxFbnRpdHk+ID0gc3RyaW5nIHwgS2V5QWxpYXNTY2hlbWE8RW50aXR5PjtcblxuZXhwb3J0IHR5cGUgSW5kZXhPcHRpb25zV2l0aEFsaWFzPEVudGl0eT4gPVxuICB8IFJlcGxhY2U8XG4gICAgICBHU0lJbmRleE9wdGlvbnMsXG4gICAgICAncGFydGl0aW9uS2V5JyB8ICdzb3J0S2V5JyxcbiAgICAgIHtcbiAgICAgICAgcGFydGl0aW9uS2V5OiBFbnRpdHlBbGlhc09yU3RyaW5nPEVudGl0eT47XG4gICAgICAgIHNvcnRLZXk6IEVudGl0eUFsaWFzT3JTdHJpbmc8RW50aXR5PjtcbiAgICAgIH1cbiAgICA+XG4gIHwgUmVwbGFjZTxcbiAgICAgIExTSUluZGV4T3B0aW9ucyxcbiAgICAgICdzb3J0S2V5JyxcbiAgICAgIHtcbiAgICAgICAgc29ydEtleTogRW50aXR5QWxpYXNPclN0cmluZzxFbnRpdHk+O1xuICAgICAgfVxuICAgID47XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXgtb3B0aW9ucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uLy4uL3BhY2thZ2VzL2NvbW1vbi9zcmMvaW5kZXgtb3B0aW9ucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHtJTkRFWF9UWVBFfSBmcm9tICcuL2VudW1zJztcbmltcG9ydCB7UmVwbGFjZX0gZnJvbSAnLi9oZWxwZXJzL3JlcGxhY2UtdHlwZSc7XG5cbi8qKlxuICogV2hlbiBhIEdsb2JhbCBTZWNvbmRhcnkgSW5kZXgoR1NJKSBpcyBjcmVhdGVkIHdpdGggYm90aCBhIHBhcnRpdGlvbiBrZXkgYW5kIGEgc29ydCBrZXksIGFueSBpdGVtcyBhZGRlZCAqIHRvIHRoZSB0YWJsZSB0aGF0IGxhY2sgYSBwYXJ0aXRpb24ga2V5IG9yIHNvcnQga2V5IHZhbHVlIHdpbGwgYmUgZXhjbHVkZWQgZnJvbSB0aGUgaW5kZXguXG4gKiBGb3IgR1NJcyB0aGF0IG9ubHkgaGF2ZSBhIHBhcnRpdGlvbiBrZXksIHRoZSBzYW1lIGJlaGF2aW91ciBhcHBsaWVzLCBidXQgb25seSB0byB0aGUgcGFydGl0aW9uIGtleS5cbiAqXG4gKiBJbiB0aGVzZSBzY2VuYXJpb3MgYGlzU3BhcnNlYCBzaG91bGQgYmUgc2V0IHRvIFRydWUuXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgR1NJSW5kZXhPcHRpb25zIHtcbiAgdHlwZTogSU5ERVhfVFlQRS5HU0k7XG4gIHBhcnRpdGlvbktleTogc3RyaW5nO1xuICBzb3J0S2V5Pzogc3RyaW5nO1xuICBpc1NwYXJzZT86IGJvb2xlYW47XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgTFNJSW5kZXhPcHRpb25zIHtcbiAgdHlwZTogSU5ERVhfVFlQRS5MU0k7XG4gIHNvcnRLZXk6IHN0cmluZztcbiAgaXNTcGFyc2U/OiBib29sZWFuO1xufVxuZXhwb3J0IHR5cGUgSW5kZXhPcHRpb25zID0gR1NJSW5kZXhPcHRpb25zIHwgTFNJSW5kZXhPcHRpb25zO1xuXG5leHBvcnQgdHlwZSBLZXlBbGlhc1NjaGVtYTxFbnRpdHk+ID0ge1xuICBhbGlhczoga2V5b2YgRW50aXR5IGV4dGVuZHMgaW5mZXIgUiA/IFIgOiBuZXZlcjtcbn07XG5leHBvcnQgdHlwZSBFbnRpdHlBbGlhc09yU3RyaW5nPEVudGl0eT4gPSBzdHJpbmcgfCBLZXlBbGlhc1NjaGVtYTxFbnRpdHk+O1xuXG5leHBvcnQgdHlwZSBJbmRleE9wdGlvbnNXaXRoQWxpYXM8RW50aXR5PiA9XG4gIHwgUmVwbGFjZTxcbiAgICAgIEdTSUluZGV4T3B0aW9ucyxcbiAgICAgICdwYXJ0aXRpb25LZXknIHwgJ3NvcnRLZXknLFxuICAgICAge1xuICAgICAgICBwYXJ0aXRpb25LZXk6IEVudGl0eUFsaWFzT3JTdHJpbmc8RW50aXR5PjtcbiAgICAgICAgc29ydEtleTogRW50aXR5QWxpYXNPclN0cmluZzxFbnRpdHk+O1xuICAgICAgfVxuICAgID5cbiAgfCBSZXBsYWNlPFxuICAgICAgTFNJSW5kZXhPcHRpb25zLFxuICAgICAgJ3NvcnRLZXknLFxuICAgICAge1xuICAgICAgICBzb3J0S2V5OiBFbnRpdHlBbGlhc09yU3RyaW5nPEVudGl0eT47XG4gICAgICB9XG4gICAgPjtcbiJdfQ==

esm/src/index-options.d.ts

 import { INDEX_TYPE } from './enums';
 import { Replace } from './helpers/replace-type';
+/**
+ * When a Global Secondary Index(GSI) is created with both a partition key and a sort key, any items added * to the table that lack a partition key or sort key value will be excluded from the index.
+ * For GSIs that only have a partition key, the same behaviour applies, but only to the partition key.
+ *
+ * In these scenarios `isSparse` should be set to True.
+ */
 export interface GSIIndexOptions {
     type: INDEX_TYPE.GSI;
     partitionKey: string;
-    sortKey: string;
-    /**
-     * DynamoDB only adds item to index if both Partition Key and Sort Key defined
-     * for any given GSI contains value
-     *
-     * Indexes missing sort key value will not be added to index.
-     */
+    sortKey?: string;
     isSparse?: boolean;
@@ -14,0 +14,0 @@ }

esm/src/index-options.js

 export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXgtb3B0aW9ucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uLy4uL3BhY2thZ2VzL2NvbW1vbi9zcmMvaW5kZXgtb3B0aW9ucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHtJTkRFWF9UWVBFfSBmcm9tICcuL2VudW1zJztcbmltcG9ydCB7UmVwbGFjZX0gZnJvbSAnLi9oZWxwZXJzL3JlcGxhY2UtdHlwZSc7XG5cbmV4cG9ydCBpbnRlcmZhY2UgR1NJSW5kZXhPcHRpb25zIHtcbiAgdHlwZTogSU5ERVhfVFlQRS5HU0k7XG4gIHBhcnRpdGlvbktleTogc3RyaW5nO1xuICBzb3J0S2V5OiBzdHJpbmc7XG4gIC8qKlxuICAgKiBEeW5hbW9EQiBvbmx5IGFkZHMgaXRlbSB0byBpbmRleCBpZiBib3RoIFBhcnRpdGlvbiBLZXkgYW5kIFNvcnQgS2V5IGRlZmluZWRcbiAgICogZm9yIGFueSBnaXZlbiBHU0kgY29udGFpbnMgdmFsdWVcbiAgICpcbiAgICogSW5kZXhlcyBtaXNzaW5nIHNvcnQga2V5IHZhbHVlIHdpbGwgbm90IGJlIGFkZGVkIHRvIGluZGV4LlxuICAgKi9cbiAgaXNTcGFyc2U/OiBib29sZWFuO1xufVxuXG5leHBvcnQgaW50ZXJmYWNlIExTSUluZGV4T3B0aW9ucyB7XG4gIHR5cGU6IElOREVYX1RZUEUuTFNJO1xuICBzb3J0S2V5OiBzdHJpbmc7XG4gIGlzU3BhcnNlPzogYm9vbGVhbjtcbn1cbmV4cG9ydCB0eXBlIEluZGV4T3B0aW9ucyA9IEdTSUluZGV4T3B0aW9ucyB8IExTSUluZGV4T3B0aW9ucztcblxuZXhwb3J0IHR5cGUgS2V5QWxpYXNTY2hlbWE8RW50aXR5PiA9IHtcbiAgYWxpYXM6IGtleW9mIEVudGl0eSBleHRlbmRzIGluZmVyIFIgPyBSIDogbmV2ZXI7XG59O1xuZXhwb3J0IHR5cGUgRW50aXR5QWxpYXNPclN0cmluZzxFbnRpdHk+ID0gc3RyaW5nIHwgS2V5QWxpYXNTY2hlbWE8RW50aXR5PjtcblxuZXhwb3J0IHR5cGUgSW5kZXhPcHRpb25zV2l0aEFsaWFzPEVudGl0eT4gPVxuICB8IFJlcGxhY2U8XG4gICAgICBHU0lJbmRleE9wdGlvbnMsXG4gICAgICAncGFydGl0aW9uS2V5JyB8ICdzb3J0S2V5JyxcbiAgICAgIHtcbiAgICAgICAgcGFydGl0aW9uS2V5OiBFbnRpdHlBbGlhc09yU3RyaW5nPEVudGl0eT47XG4gICAgICAgIHNvcnRLZXk6IEVudGl0eUFsaWFzT3JTdHJpbmc8RW50aXR5PjtcbiAgICAgIH1cbiAgICA+XG4gIHwgUmVwbGFjZTxcbiAgICAgIExTSUluZGV4T3B0aW9ucyxcbiAgICAgICdzb3J0S2V5JyxcbiAgICAgIHtcbiAgICAgICAgc29ydEtleTogRW50aXR5QWxpYXNPclN0cmluZzxFbnRpdHk+O1xuICAgICAgfVxuICAgID47XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXgtb3B0aW9ucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uLy4uL3BhY2thZ2VzL2NvbW1vbi9zcmMvaW5kZXgtb3B0aW9ucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHtJTkRFWF9UWVBFfSBmcm9tICcuL2VudW1zJztcbmltcG9ydCB7UmVwbGFjZX0gZnJvbSAnLi9oZWxwZXJzL3JlcGxhY2UtdHlwZSc7XG5cbi8qKlxuICogV2hlbiBhIEdsb2JhbCBTZWNvbmRhcnkgSW5kZXgoR1NJKSBpcyBjcmVhdGVkIHdpdGggYm90aCBhIHBhcnRpdGlvbiBrZXkgYW5kIGEgc29ydCBrZXksIGFueSBpdGVtcyBhZGRlZCAqIHRvIHRoZSB0YWJsZSB0aGF0IGxhY2sgYSBwYXJ0aXRpb24ga2V5IG9yIHNvcnQga2V5IHZhbHVlIHdpbGwgYmUgZXhjbHVkZWQgZnJvbSB0aGUgaW5kZXguXG4gKiBGb3IgR1NJcyB0aGF0IG9ubHkgaGF2ZSBhIHBhcnRpdGlvbiBrZXksIHRoZSBzYW1lIGJlaGF2aW91ciBhcHBsaWVzLCBidXQgb25seSB0byB0aGUgcGFydGl0aW9uIGtleS5cbiAqXG4gKiBJbiB0aGVzZSBzY2VuYXJpb3MgYGlzU3BhcnNlYCBzaG91bGQgYmUgc2V0IHRvIFRydWUuXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgR1NJSW5kZXhPcHRpb25zIHtcbiAgdHlwZTogSU5ERVhfVFlQRS5HU0k7XG4gIHBhcnRpdGlvbktleTogc3RyaW5nO1xuICBzb3J0S2V5Pzogc3RyaW5nO1xuICBpc1NwYXJzZT86IGJvb2xlYW47XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgTFNJSW5kZXhPcHRpb25zIHtcbiAgdHlwZTogSU5ERVhfVFlQRS5MU0k7XG4gIHNvcnRLZXk6IHN0cmluZztcbiAgaXNTcGFyc2U/OiBib29sZWFuO1xufVxuZXhwb3J0IHR5cGUgSW5kZXhPcHRpb25zID0gR1NJSW5kZXhPcHRpb25zIHwgTFNJSW5kZXhPcHRpb25zO1xuXG5leHBvcnQgdHlwZSBLZXlBbGlhc1NjaGVtYTxFbnRpdHk+ID0ge1xuICBhbGlhczoga2V5b2YgRW50aXR5IGV4dGVuZHMgaW5mZXIgUiA/IFIgOiBuZXZlcjtcbn07XG5leHBvcnQgdHlwZSBFbnRpdHlBbGlhc09yU3RyaW5nPEVudGl0eT4gPSBzdHJpbmcgfCBLZXlBbGlhc1NjaGVtYTxFbnRpdHk+O1xuXG5leHBvcnQgdHlwZSBJbmRleE9wdGlvbnNXaXRoQWxpYXM8RW50aXR5PiA9XG4gIHwgUmVwbGFjZTxcbiAgICAgIEdTSUluZGV4T3B0aW9ucyxcbiAgICAgICdwYXJ0aXRpb25LZXknIHwgJ3NvcnRLZXknLFxuICAgICAge1xuICAgICAgICBwYXJ0aXRpb25LZXk6IEVudGl0eUFsaWFzT3JTdHJpbmc8RW50aXR5PjtcbiAgICAgICAgc29ydEtleTogRW50aXR5QWxpYXNPclN0cmluZzxFbnRpdHk+O1xuICAgICAgfVxuICAgID5cbiAgfCBSZXBsYWNlPFxuICAgICAgTFNJSW5kZXhPcHRpb25zLFxuICAgICAgJ3NvcnRLZXknLFxuICAgICAge1xuICAgICAgICBzb3J0S2V5OiBFbnRpdHlBbGlhc09yU3RyaW5nPEVudGl0eT47XG4gICAgICB9XG4gICAgPjtcbiJdfQ==

package.json

 {
   "name": "@typedorm/common",
-  "version": "1.16.0-beta.5",
+  "version": "1.16.0-beta.6",
   "type": "commonjs",
@@ -5,0 +5,0 @@ "main": "cjs/index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

332706

increased by0.23%

No dependency changes