Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implemented eventarc event publishing API #1617

Merged
merged 21 commits into from
Apr 13, 2022
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions entrypoints.json
Expand Up @@ -55,5 +55,9 @@
"firebase-admin/remote-config": {
"typings": "./lib/remote-config/index.d.ts",
"dist": "./lib/remote-config/index.js"
},
"firebase-admin/eventarc": {
"typings": "./lib/eventarc/index.d.ts",
"dist": "./lib/eventarc/index.js"
}
}
17 changes: 17 additions & 0 deletions etc/firebase-admin.api.md
Expand Up @@ -27,6 +27,8 @@ export namespace app {
database(url?: string): database.Database;
delete(): Promise<void>;
// (undocumented)
eventarc(): eventarc.Eventarc;
// (undocumented)
firestore(): firestore.Firestore;
// (undocumented)
installations(): installations.Installations;
Expand Down Expand Up @@ -218,6 +220,21 @@ export namespace database {
const ServerValue: rtdb.ServerValue;
}

// @public
export function eventarc(app?: App): eventarc.Eventarc;

// @public (undocumented)
export namespace eventarc {
// Warning: (ae-forgotten-export) The symbol "Channel" needs to be exported by the entry point default-namespace.d.ts
export type Channel = Channel;
// Warning: (ae-forgotten-export) The symbol "ChannelOptions" needs to be exported by the entry point default-namespace.d.ts
export type ChannelOptions = ChannelOptions;
// Warning: (ae-forgotten-export) The symbol "CloudEvent" needs to be exported by the entry point default-namespace.d.ts
export type CloudEvent = CloudEvent;
// Warning: (ae-forgotten-export) The symbol "Eventarc" needs to be exported by the entry point default-namespace.d.ts
export type Eventarc = Eventarc;
}

// @public
export interface FirebaseArrayIndexError {
error: FirebaseError;
Expand Down
67 changes: 67 additions & 0 deletions etc/firebase-admin.eventarc.api.md
@@ -0,0 +1,67 @@
## API Report File for "firebase-admin.eventarc"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

/// <reference types="node" />

import { Agent } from 'http';

// @public
export class Channel {
// (undocumented)
readonly allowedEventTypes?: string[];
pavelgj marked this conversation as resolved.
Show resolved Hide resolved
get eventarc(): Eventarc;
// (undocumented)
get name(): string;
// (undocumented)
nameInternal: string;
publish(events: CloudEvent | CloudEvent[]): Promise<void>;
}

// @public
export interface ChannelOptions {
allowedEventTypes?: string[] | string | undefined;
}

// @public
export interface CloudEvent {
// (undocumented)
[key: string]: unknown;
// (undocumented)
data?: object | string;
// (undocumented)
datacontenttype?: string;
// (undocumented)
id?: string;
// (undocumented)
source?: string;
// (undocumented)
specversion?: CloudEventVersion;
// (undocumented)
subject?: string;
// (undocumented)
time?: string;
// (undocumented)
type: string;
}

// @public
export type CloudEventVersion = '1.0';

// @public
export class Eventarc {
// Warning: (ae-forgotten-export) The symbol "App" needs to be exported by the entry point index.d.ts
get app(): App;
channel(options?: ChannelOptions): Channel;
channel(name: string, options?: ChannelOptions): Channel;
channel(options?: ChannelOptions): Channel;
}

// @public
export function getEventarc(app?: App): Eventarc;

// (No @packageDocumentation comment for this package)

```