refactor!: use snake case for generated cloudevent files (#382)

This is consistent with other filenames in the project.
GoogleCloudPlatform · Nov 6, 2021 · 05a0527 · 05a0527
1 parent 81ba122
commit 05a0527
Show file tree

Hide file tree

Showing 23 changed files with 141 additions and 177 deletions.
diff --git a/docs/generated/api.d.ts b/docs/generated/api.d.ts
@@ -27,27 +27,27 @@ export declare interface CloudEventFunctionWithCallback {
 }
 
 /**
- * The CloudEvents v1.0 context object for the event.
- * {@link https://github.com/cloudevents/spec/blob/master/spec.md#context-attributes}
+ * The CloudEvents v1.0 context attributes.
+ * {@link https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#context-attributes}
  * @public
  */
 export declare interface CloudEventsContext {
     /**
-     * Type of occurrence which has happened.
+     * ID of the event.
      */
-    type?: string;
+    id: string;
     /**
-     * The version of the CloudEvents specification which the event uses.
+     * The event producer.
      */
-    specversion?: string;
+    source: string;
     /**
-     * The event producer.
+     * The version of the CloudEvents specification which the event uses.
      */
-    source?: string;
+    specversion: string;
     /**
-     * ID of the event.
+     * Type of occurrence which has happened.
      */
-    id?: string;
+    type: string;
     /**
      * Timestamp of when the event happened.
      */
@@ -64,15 +64,15 @@ export declare interface CloudEventsContext {
      * Content type of the event data.
      */
     datacontenttype?: string;
-    /**
-     * The event data.
-     */
-    data?: Record<string, unknown | string | number | boolean> | string | number | boolean | null | unknown;
     /**
      * The traceparent string, containing a trace version, trace ID, span ID, and trace options.
      * @see https://github.com/cloudevents/spec/blob/master/extensions/distributed-tracing.md
      */
     traceparent?: string;
+    /**
+     * The event payload.
+     */
+    data?: any;
 }
 
 /**

diff --git a/docs/generated/api.json b/docs/generated/api.json
@@ -336,7 +336,7 @@
         {
           "kind": "Interface",
           "canonicalReference": "@google-cloud/functions-framework!CloudEventsContext:interface",
-          "docComment": "/**\n * The CloudEvents v1.0 context object for the event. {@link https://github.com/cloudevents/spec/blob/master/spec.md#context-attributes}\n *\n * @public\n */\n",
+          "docComment": "/**\n * The CloudEvents v1.0 context attributes. {@link https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#context-attributes}\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -349,20 +349,15 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@google-cloud/functions-framework!CloudEventsContext#data:member",
-              "docComment": "/**\n * The event data.\n */\n",
+              "docComment": "/**\n * The event payload.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
                   "text": "data?: "
                 },
-                {
-                  "kind": "Reference",
-                  "text": "Record",
-                  "canonicalReference": "!Record:type"
-                },
                 {
                   "kind": "Content",
-                  "text": "<string, unknown | string | number | boolean> | string | number | boolean | null | unknown"
+                  "text": "any"
                 },
                 {
                   "kind": "Content",
@@ -374,7 +369,7 @@
               "name": "data",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 3
+                "endIndex": 2
               }
             },
             {
@@ -436,7 +431,7 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "id?: "
+                  "text": "id: "
                 },
                 {
                   "kind": "Content",
@@ -447,7 +442,7 @@
                   "text": ";"
                 }
               ],
-              "isOptional": true,
+              "isOptional": false,
               "releaseTag": "Public",
               "name": "id",
               "propertyTypeTokenRange": {
@@ -462,7 +457,7 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "source?: "
+                  "text": "source: "
                 },
                 {
                   "kind": "Content",
@@ -473,7 +468,7 @@
                   "text": ";"
                 }
               ],
-              "isOptional": true,
+              "isOptional": false,
               "releaseTag": "Public",
               "name": "source",
               "propertyTypeTokenRange": {
@@ -488,7 +483,7 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "specversion?: "
+                  "text": "specversion: "
                 },
                 {
                   "kind": "Content",
@@ -499,7 +494,7 @@
                   "text": ";"
                 }
               ],
-              "isOptional": true,
+              "isOptional": false,
               "releaseTag": "Public",
               "name": "specversion",
               "propertyTypeTokenRange": {
@@ -592,7 +587,7 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "type?: "
+                  "text": "type: "
                 },
                 {
                   "kind": "Content",
@@ -603,7 +598,7 @@
                   "text": ";"
                 }
               ],
-              "isOptional": true,
+              "isOptional": false,
               "releaseTag": "Public",
               "name": "type",
               "propertyTypeTokenRange": {

diff --git a/docs/generated/api.md b/docs/generated/api.md
@@ -25,16 +25,16 @@ export interface CloudEventFunctionWithCallback {
 
 // @public
 export interface CloudEventsContext {
-    data?: Record<string, unknown | string | number | boolean> | string | number | boolean | null | unknown;
+    data?: any;
     datacontenttype?: string;
     dataschema?: string;
-    id?: string;
-    source?: string;
-    specversion?: string;
+    id: string;
+    source: string;
+    specversion: string;
     subject?: string;
     time?: string;
     traceparent?: string;
-    type?: string;
+    type: string;
 }
 
 // @public

diff --git a/experimental/generate_cloud_events/README.md b/experimental/generate_cloud_events/README.md
@@ -8,4 +8,4 @@ It can be run via the following command:
 npm run generate_cloudevents
 ```
 
-This will regenerate all known CloudEvent type interfaces in the `src/cloudevent_types` directory of this repository.
+This will regenerate all known CloudEvent type interfaces in the `src/cloud_event_types` directory of this repository.
diff --git a/experimental/generate_cloud_events/package.json b/experimental/generate_cloud_events/package.json
@@ -5,7 +5,7 @@
   "main": "build/src/index.js",
   "dependencies": {},
   "scripts": {
-    "generate_cloudevents": "ts-node ./src/generate.ts && gts fix ../../src/cloudevent_types/**/*.ts"
+    "generate_cloudevents": "ts-node ./src/generate.ts && gts fix ../../src/cloud_event_types/**/*.ts"
   },
   "files": [
     "build/src/**/*.js",

diff --git a/experimental/generate_cloud_events/src/generate.ts b/experimental/generate_cloud_events/src/generate.ts
@@ -116,8 +116,13 @@ const generateInterfaceBody = (properties: {
  */
 const generateCloudEventImport = (): t.Statement => {
   return t.importDeclaration(
-    [t.importSpecifier(t.identifier('CloudEvent'), t.identifier('CloudEvent'))],
-    t.stringLiteral('./CloudEvent')
+    [
+      t.importSpecifier(
+        t.identifier('CloudEventsContext'),
+        t.identifier('CloudEventsContext')
+      ),
+    ],
+    t.stringLiteral('./cloud_events_context')
   );
 };
 
@@ -156,7 +161,7 @@ const generateCloudEventInterface = (schema: TypeSchema): t.Statement => {
     t.tsInterfaceDeclaration(
       t.identifier(schema.name.replace(/Data$/, 'CloudEvent')),
       null,
-      [t.tsExpressionWithTypeArguments(t.identifier('CloudEvent'))],
+      [t.tsExpressionWithTypeArguments(t.identifier('CloudEventsContext'))],
       t.tsInterfaceBody([
         t.tsPropertySignature(
           t.identifier('type'),
@@ -248,6 +253,6 @@ utils.fetch(ROOT_TYPE_CATALOG_URL).then(catalog => {
     utils.addCopyright(ast);
 
     const {code} = generate(ast);
-    fs.writeFileSync(utils.RELATIVE_SRC_DIR + '/GoogleCloudEvent.ts', code);
+    fs.writeFileSync(utils.RELATIVE_SRC_DIR + '/google_cloud_event.ts', code);
   });
 });
diff --git a/experimental/generate_cloud_events/src/utils.ts b/experimental/generate_cloud_events/src/utils.ts
@@ -19,7 +19,7 @@ import * as https from 'https';
 /**
  * Relative path of src dictory to write the TS files ts.
  */
-export const RELATIVE_SRC_DIR = '../../src/cloudevent_types';
+export const RELATIVE_SRC_DIR = '../../src/cloud_event_types';
 
 /**
  * Add a JSDoc comment to an AST node
@@ -72,7 +72,11 @@ export const fetch = (url: string): Promise<{[key: string]: any}> => {
 export const getDataFilePath = (url: string): string => {
   return (
     RELATIVE_SRC_DIR +
-    url.split('jsonschema/google/events')[1].replace('.json', '.ts')
+    url
+      .split('jsonschema/google/events')[1]
+      .replace('.json', '.ts')
+      .replace(/[A-Z]/g, letter => `_${letter.toLowerCase()}`)
+      .replace('/_', '/')
   );
 };
 

diff --git a/src/cloud_event_types/CloudEvent.ts b/src/cloud_event_types/CloudEvent.ts
diff --git a/...vent_types/cloud/audit/v1/LogEntryData.ts → ...nt_types/cloud/audit/v1/log_entry_data.ts b/...vent_types/cloud/audit/v1/LogEntryData.ts → ...nt_types/cloud/audit/v1/log_entry_data.ts
diff --git a/...pes/cloud/cloudbuild/v1/BuildEventData.ts → ...s/cloud/cloudbuild/v1/build_event_data.ts b/...pes/cloud/cloudbuild/v1/BuildEventData.ts → ...s/cloud/cloudbuild/v1/build_event_data.ts
diff --git a/...s/cloud/firestore/v1/DocumentEventData.ts → ...cloud/firestore/v1/document_event_data.ts b/...s/cloud/firestore/v1/DocumentEventData.ts → ...cloud/firestore/v1/document_event_data.ts
diff --git a/...s/cloud/pubsub/v1/MessagePublishedData.ts → ...cloud/pubsub/v1/message_published_data.ts b/...s/cloud/pubsub/v1/MessagePublishedData.ts → ...cloud/pubsub/v1/message_published_data.ts
diff --git a/...es/cloud/scheduler/v1/SchedulerJobData.ts → .../cloud/scheduler/v1/scheduler_job_data.ts b/...es/cloud/scheduler/v1/SchedulerJobData.ts → .../cloud/scheduler/v1/scheduler_job_data.ts
diff --git a/...pes/cloud/storage/v1/StorageObjectData.ts → ...s/cloud/storage/v1/storage_object_data.ts b/...pes/cloud/storage/v1/StorageObjectData.ts → ...s/cloud/storage/v1/storage_object_data.ts
diff --git a/src/cloud_event_types/cloud_events_context.ts b/src/cloud_event_types/cloud_events_context.ts
@@ -0,0 +1,63 @@
+// Copyright 2021 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// 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.
+
+/**
+ * The CloudEvents v1.0 context attributes.
+ * {@link https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#context-attributes}
+ * @public
+ */
+export interface CloudEventsContext {
+  /**
+   * ID of the event.
+   */
+  id: string;
+  /**
+   * The event producer.
+   */
+  source: string;
+  /**
+   * The version of the CloudEvents specification which the event uses.
+   */
+  specversion: string;
+  /**
+   * Type of occurrence which has happened.
+   */
+  type: string;
+  /**
+   * Timestamp of when the event happened.
+   */
+  time?: string;
+  /**
+   * Describes the subject of the event in the context of the event producer.
+   */
+  subject?: string;
+  /**
+   * A link to the schema that the event data adheres to.
+   */
+  dataschema?: string;
+  /**
+   * Content type of the event data.
+   */
+  datacontenttype?: string;
+  /**
+   * The traceparent string, containing a trace version, trace ID, span ID, and trace options.
+   * @see https://github.com/cloudevents/spec/blob/master/extensions/distributed-tracing.md
+   */
+  traceparent?: string;
+  /**
+   * The event payload.
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  data?: any;
+}
diff --git a/...firebase/analytics/v1/AnalyticsLogData.ts → ...rebase/analytics/v1/analytics_log_data.ts b/...firebase/analytics/v1/AnalyticsLogData.ts → ...rebase/analytics/v1/analytics_log_data.ts
diff --git a/...t_types/firebase/auth/v1/AuthEventData.ts → ...types/firebase/auth/v1/auth_event_data.ts b/...t_types/firebase/auth/v1/AuthEventData.ts → ...types/firebase/auth/v1/auth_event_data.ts
diff --git a/...irebase/database/v1/ReferenceEventData.ts → ...ebase/database/v1/reference_event_data.ts b/...irebase/database/v1/ReferenceEventData.ts → ...ebase/database/v1/reference_event_data.ts
diff --git a/.../remoteconfig/v1/RemoteConfigEventData.ts → ...moteconfig/v1/remote_config_event_data.ts b/.../remoteconfig/v1/RemoteConfigEventData.ts → ...moteconfig/v1/remote_config_event_data.ts
diff --git a/...irebase/testlab/v1/TestMatrixEventData.ts → ...base/testlab/v1/test_matrix_event_data.ts b/...irebase/testlab/v1/TestMatrixEventData.ts → ...base/testlab/v1/test_matrix_event_data.ts