Merge pull request #116 from nitrictech/develop

tjholm · web-flow · commit 72872c51f086 · 2022-03-28T12:40:09.000+11:00
Release
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -0,0 +1,45 @@
+---
+name: Bug Report
+about: Report a bug encountered while using nitric
+labels: bug
+---
+
+**Describe the bug**
+<!--
+A clear and concise description of what the bug is. What happened?
+-->
+
+**Expected behavior**
+
+<!--
+A clear and concise description of what you expected to happen.
+-->
+
+**To Reproduce**
+
+Steps to reproduce the behavior:
+
+<!--
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+-->
+
+**Output of `nitric info -o yaml`:**
+
+<!--
+(paste your output here)
+-->
+
+**Brief description of your project**
+
+<!--
+What are you building with Nitric?
+-->
+
+**Additional context**
+
+<!--
+Add any other context about the problem here.
+-->
diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md
@@ -0,0 +1,37 @@
+---
+name: Enhancement Request
+about: Suggest an enhancement to nitric
+labels: enhancement
+
+---
+
+**Describe the solution you'd like**
+<!--
+A clear and concise description of what you want to be added.
+-->
+
+**Why is this needed? What challenge will it help you solve? Please describe.**
+<!--
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+-->
+
+**Describe alternatives you've considered**
+<!--
+A clear and concise description of any alternative solutions or features you've considered.
+-->
+
+**Output of `nitric info -o yaml`:**
+
+<!--
+(paste your output here)
+-->
+
+**Brief description of your project**
+<!--
+What are you building with Nitric?
+-->
+
+**Additional context**
+<!--
+Add any other context or screenshots about the feature request here.
+-->
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -12,9 +12,6 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v2
-      with:
-        token: ${{secrets.SUB_MODULE_PAT}}
-        submodules: recursive
     - name: Cache Yarn Cache
       uses: actions/cache@v2
       with:
diff --git a/README.md b/README.md
@@ -8,14 +8,26 @@
 [![Version](https://img.shields.io/npm/v/@nitric/sdk.svg)](https://npmjs.org/package/@nitric/sdk)
 [![Downloads/week](https://img.shields.io/npm/dw/@nitric/sdk.svg)](https://npmjs.org/package/@nitric/sdk)
 
-# @nitric/sdk
-The NodeJS SDK supports the use of the cloud-portable [Nitric](https://nitric.io) framework with NodeJS 12+.
-> The SDK is in early stage development and APIs and interfaces are still subject to breaking changes
+# Node SDK for Nitric
 
-## Prerequisites
-- NodeJS 12+
+The NodeJS SDK supports the use of the Nitric framework with NodeJS 12+. For more information, check out the main [Nitric repo](https://github.com/nitrictech/nitric).
 
-## Getting Started
+Nitric SDKs provide an infrastructure-as-code style that lets you define resources in code. You can also write the functions that support the logic behind APIs, subscribers and schedules.
 
-Checkout the [nitric docs](https://nitric.io/docs) to see how to get started using nitric
+You can request the type of access you need to resources such as publishing for topics, without dealing directly with IAM or policy documents.
 
+## Status
+
+The SDK is in early stage development and APIs and interfaces are still subject to breaking changes. We’d love your feedback as we build additional functionality!
+
+## Get in touch:
+
+- Ask questions in [GitHub discussions](https://github.com/nitrictech/nitric/discussions)
+
+- Find us on [Twitter](https://twitter.com/nitric_io)
+
+- Send us an [email](mailto:maintainers@nitric.io)
+
+## Get Started
+
+Check out the [Nitric docs](https://nitric.io/docs) to see how to get started using Nitric.
diff --git a/package.json b/package.json
@@ -26,8 +26,8 @@
     "David Moore <david.moore@nitric.io>"
   ],
   "dependencies": {
-    "@grpc/grpc-js": "^1.1.7",
-    "@nitric/api": "^0.13.0",
+    "@grpc/grpc-js": "^1.5.9",
+    "@nitric/api": "0.15.0",
     "common-tags": "^1.8.0",
     "google-protobuf": "3.14.0",
     "path-parser": "^6.1.0",
diff --git a/src/api/documents/v0/collection-group-ref.ts b/src/api/documents/v0/collection-group-ref.ts
@@ -15,7 +15,7 @@ import { DocumentServiceClient } from '@nitric/api/proto/document/v1/document_gr
 import { InvalidArgumentError } from '../../errors';
 import { CollectionRef } from './collection-ref';
 import { MAX_COLLECTION_DEPTH } from './constants';
-import { DocumentRef } from './document-ref';
+import { DocumentRef, DocumentStructure } from './document-ref';
 import { Query } from './query';
 
 const NIL_DOC_ID = '';
@@ -25,7 +25,7 @@ const NIL_DOC_ID = '';
  *
  * Provides a Document API CollectionGroupRef class.
  */
-export class CollectionGroupRef<T extends { [key: string]: any }> {
+export class CollectionGroupRef<T extends DocumentStructure> {
   private documentClient: DocumentServiceClient;
   public readonly parent: CollectionGroupRef<any>;
   public readonly name: string;
@@ -44,7 +44,7 @@ export class CollectionGroupRef<T extends { [key: string]: any }> {
    * Create a CollectionGroupRef referencing a sub-collection of this collection
    * @param name
    */
-  public collection<T extends { [key: string]: any }>(
+  public collection<T extends DocumentStructure>(
     name: string
   ): CollectionGroupRef<T> {
     if (this.depth() >= MAX_COLLECTION_DEPTH) {
diff --git a/src/api/documents/v0/collection-ref.ts b/src/api/documents/v0/collection-ref.ts
@@ -14,15 +14,15 @@
 import { Collection } from '@nitric/api/proto/document/v1/document_pb';
 import { DocumentServiceClient } from '@nitric/api/proto/document/v1/document_grpc_pb';
 import { Query } from './query';
-import { DocumentRef } from './document-ref';
+import { DocumentRef, DocumentStructure } from './document-ref';
 import { CollectionGroupRef } from './collection-group-ref';
 
 /**
  * CollectionRef
  *
  * Provides a Document API CollectionRef class.
  */
-export class CollectionRef<T extends { [key: string]: any }> {
+export class CollectionRef<T extends DocumentStructure> {
   private documentClient: DocumentServiceClient;
   public readonly name: string;
   public readonly parent?: DocumentRef<any>;
diff --git a/src/api/documents/v0/document-ref.ts b/src/api/documents/v0/document-ref.ts
@@ -24,13 +24,15 @@ import { fromGrpcError, InvalidArgumentError } from '../../errors';
 import { CollectionRef } from './collection-ref';
 import { MAX_COLLECTION_DEPTH } from './constants';
 
+export type DocumentStructure = Record<string, any>;
+
 /**
  * Document Ref
  *
  * Provides a Document Reference class.
  * Used to create references to collections.
  */
-export class DocumentRef<T extends { [key: string]: any }> {
+export class DocumentRef<T extends DocumentStructure> {
   private documentClient: DocumentServiceClient;
   public readonly parent: CollectionRef<T>;
   public readonly id: string;
@@ -112,14 +114,10 @@ export class DocumentRef<T extends { [key: string]: any }> {
     });
   }
 
-  /**
-   *
-   */
   private toWire(): Key {
     const key = new Key();
     key.setCollection(this.parent["toWire"]());
     key.setId(this.id);
-
     return key;
   }
 
@@ -138,7 +136,7 @@ export class DocumentRef<T extends { [key: string]: any }> {
    * @param name The name of the collection (required)
    * @returns The Collection instance
    */
-  public collection<T extends { [key: string]: any }>(
+  public collection<T extends DocumentStructure>(
     name: string
   ): CollectionRef<T> {
     if (this.depth() >= MAX_COLLECTION_DEPTH) {
diff --git a/src/api/documents/v0/document-snapshot.ts b/src/api/documents/v0/document-snapshot.ts
@@ -11,9 +11,9 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-import { DocumentRef } from './document-ref';
+import { DocumentRef, DocumentStructure } from './document-ref';
 
-export class DocumentSnapshot<T> {
+export class DocumentSnapshot<T extends DocumentStructure> {
   public readonly ref: DocumentRef<T>;
   public readonly content: T;
 
diff --git a/src/api/documents/v0/documents.ts b/src/api/documents/v0/documents.ts
@@ -15,6 +15,7 @@ import { SERVICE_BIND } from '../../../constants';
 import { DocumentServiceClient } from '@nitric/api/proto/document/v1/document_grpc_pb';
 import * as grpc from '@grpc/grpc-js';
 import { CollectionRef } from './collection-ref';
+import { DocumentStructure } from './document-ref';
 
 /**
  * Documents
@@ -37,7 +38,7 @@ export class Documents {
    * @param name The name of the collection (required)
    * @returns The Collection instance
    */
-  public collection<T extends { [key: string]: any }>(name: string) {
+  public collection<T extends DocumentStructure>(name: string) {
     return new CollectionRef<T>(this.documentClient, name);
   }
 }
diff --git a/src/api/documents/v0/query.ts b/src/api/documents/v0/query.ts
@@ -23,7 +23,7 @@ import {
 import { DocumentServiceClient } from '@nitric/api/proto/document/v1/document_grpc_pb';
 import { WhereQueryOperator, WhereValueExpression } from '../../../types';
 import type { Map as ProtobufMap } from 'google-protobuf';
-import { DocumentRef } from './document-ref';
+import { DocumentRef, DocumentStructure } from './document-ref';
 import { CollectionRef } from './collection-ref';
 import { DocumentSnapshot } from './document-snapshot';
 import { fromGrpcError, InvalidArgumentError } from '../../errors';
@@ -61,7 +61,7 @@ function protoMapToMap(
  * Provides a Document API client.
  * Used to create references to collections.
  */
-export class Query<T extends { [key: string]: any }> {
+export class Query<T extends DocumentStructure> {
   private documentClient: DocumentServiceClient;
   public readonly collection: CollectionRef<T>;
   private expressions: Expression[];
diff --git a/src/api/queues/v0/queues.ts b/src/api/queues/v0/queues.ts
@@ -125,6 +125,7 @@ export class Queue {
       this.queueing.QueueServiceClient.sendBatch(request, (error, response) => {
         if (error) {
           reject(fromGrpcError(error));
+          return;
         }
         const failedTasks = response.getFailedtasksList().map((m) => ({
           task: {
diff --git a/src/api/secrets/v0/secrets.ts b/src/api/secrets/v0/secrets.ts
@@ -62,7 +62,7 @@ export class Secrets {
 /**
  * A reference to a secret.
  */
-class Secret {
+export class Secret {
   readonly secrets: Secrets;
   readonly name: string;
 
@@ -234,7 +234,7 @@ class SecretVersion {
 
 /**
  * Container for a SecretValue
- * Also provides addtional metadata about the actual accessed secret version in the case that "latest" is used
+ * Also provides additional metadata about the actual accessed secret version in the case that "latest" is used
  */
 class SecretValue {
   readonly secretVersion: SecretVersion;
diff --git a/src/api/storage/v0/storage.ts b/src/api/storage/v0/storage.ts
@@ -35,6 +35,12 @@ export class Storage {
     );
   }
 
+  /**
+   * Create a bucket reference.
+   * 
+   * @param name of the bucket to reference
+   * @returns a bucket reference
+   */
   bucket = (name: string): Bucket => {
     if (!name) {
       throw new InvalidArgumentError(
@@ -73,6 +79,10 @@ export enum FileMode {
 }
 
 export interface SignUrlOptions {
+  /**
+   * The number of seconds the signed URL remains valid.
+   * The minimum value is 1 and the maximum value is 604800 (7 days).
+   */
   expiry?: number;
 }
 
@@ -127,9 +137,9 @@ export class File {
   };
 
   /**
-   * Write a an array of bytes to this file
+   * Write an array of bytes to the file
    * @param body The file contents to write
-   * @retuns A void promise
+   * @returns A void promise
    *
    * Example:
    * ```typescript
diff --git a/src/faas/v0/context.ts b/src/faas/v0/context.ts
@@ -181,7 +181,7 @@ export class HttpContext extends TriggerContext<HttpRequest, HttpResponse> {
 
     const headers = ((http
       .getHeadersMap()
-      // XXX: getEntryList claims to return [string, faas.HeaderValue][], but really returns [string, string[][]][]
+      // getEntryList claims to return [string, faas.HeaderValue][], but really returns [string, string[][]][]
       // we force the type to match the real return type.
       .getEntryList() as unknown) as [string, string[][]][]).reduce(
       (acc, [key, [val]]) => ({
@@ -193,7 +193,7 @@ export class HttpContext extends TriggerContext<HttpRequest, HttpResponse> {
 
     const query = ((http
       .getQueryParamsMap()
-      // XXX: getEntryList claims to return [string, faas.HeaderValue][], but really returns [string, string[][]][]
+      // getEntryList claims to return [string, faas.HeaderValue][], but really returns [string, string[][]][]
       // we force the type to match the real return type.
       .getEntryList() as unknown) as [string, string[][]][]).reduce(
       (acc, [key, [val]]) => ({
@@ -205,7 +205,7 @@ export class HttpContext extends TriggerContext<HttpRequest, HttpResponse> {
 
     const params = http
       .getPathParamsMap()
-      // XXX: getEntryList claims to return [string, faas.HeaderValue][], but really returns [string, string[][]][]
+      // getEntryList claims to return [string, faas.HeaderValue][], but really returns [string, string[][]][]
       // we force the type to match the real return type.
       .getEntryList()
       .reduce(
diff --git a/src/faas/v0/start.test.ts b/src/faas/v0/start.test.ts
@@ -63,7 +63,6 @@ describe('faas.start', () => {
     });
 
     it('The first sent message should be an InitRequest', () => {
-      // TODO: Add test
       expect(mockStream.receivedMessages[0].hasInitRequest()).toBe(true);
     });
 
diff --git a/src/resources/collection.ts b/src/resources/collection.ts
diff --git a/src/resources/index.ts b/src/resources/index.ts
diff --git a/src/resources/secret.test.ts b/src/resources/secret.test.ts
diff --git a/src/resources/secret.ts b/src/resources/secret.ts
diff --git a/src/resources/topic.ts b/src/resources/topic.ts
diff --git a/src/types.ts b/src/types.ts
diff --git a/yarn.lock b/yarn.lock
