Compare commits
6 Commits
Author | SHA1 | Date | |
---|---|---|---|
![]() |
094c6c0c27 | ||
![]() |
1f520ed590 | ||
![]() |
686c834748 | ||
![]() |
d6b9410932 | ||
![]() |
dff1c5e387 | ||
![]() |
9b51e0f746 |
@@ -0,0 +1,116 @@
|
|||||||
|
import defineAction from '../../../../helpers/define-action.js';
|
||||||
|
|
||||||
|
export default defineAction({
|
||||||
|
name: 'Create Cloud Firestore document',
|
||||||
|
key: 'createCloudFirestoreDocument',
|
||||||
|
description: 'Creates a new document within a Cloud Firestore collection.',
|
||||||
|
arguments: [
|
||||||
|
{
|
||||||
|
label: 'Collection',
|
||||||
|
key: 'collectionId',
|
||||||
|
type: 'dropdown',
|
||||||
|
required: true,
|
||||||
|
description: '',
|
||||||
|
variables: true,
|
||||||
|
source: {
|
||||||
|
type: 'query',
|
||||||
|
name: 'getDynamicData',
|
||||||
|
arguments: [
|
||||||
|
{
|
||||||
|
name: 'key',
|
||||||
|
value: 'listFirestoreCollections',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Convert Numerics',
|
||||||
|
key: 'convertNumerics',
|
||||||
|
type: 'dropdown',
|
||||||
|
required: false,
|
||||||
|
description:
|
||||||
|
"If any value represents a valid numerical value, whether it's an integer or a floating-point number, this field directs the database to store it as a numeric data type instead of a string.",
|
||||||
|
variables: true,
|
||||||
|
options: [
|
||||||
|
{ label: 'Yes', value: true },
|
||||||
|
{ label: 'No', value: false },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Document ID',
|
||||||
|
key: 'documentId',
|
||||||
|
type: 'string',
|
||||||
|
required: false,
|
||||||
|
description:
|
||||||
|
'The document ID to use for this document. If not specified, an ID will be assigned.',
|
||||||
|
variables: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Document Data',
|
||||||
|
key: 'documentData',
|
||||||
|
type: 'dynamic',
|
||||||
|
required: false,
|
||||||
|
description: '',
|
||||||
|
fields: [
|
||||||
|
{
|
||||||
|
label: 'Key',
|
||||||
|
key: 'key',
|
||||||
|
type: 'string',
|
||||||
|
required: false,
|
||||||
|
variables: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Value',
|
||||||
|
key: 'value',
|
||||||
|
type: 'string',
|
||||||
|
required: false,
|
||||||
|
variables: true,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
|
||||||
|
async run($) {
|
||||||
|
const projectId = $.auth.data.projectId;
|
||||||
|
const { collectionId, documentId, documentData, convertNumerics } =
|
||||||
|
$.step.parameters;
|
||||||
|
|
||||||
|
const documentDataObject = documentData.reduce((result, entry) => {
|
||||||
|
const key = entry.key?.toLowerCase();
|
||||||
|
const value = entry.value;
|
||||||
|
const isNumber = !isNaN(parseFloat(value));
|
||||||
|
|
||||||
|
if (key && value) {
|
||||||
|
const formattedValue =
|
||||||
|
convertNumerics && isNumber
|
||||||
|
? { integerValue: parseFloat(value) }
|
||||||
|
: { stringValue: value };
|
||||||
|
|
||||||
|
return {
|
||||||
|
...result,
|
||||||
|
[key]: formattedValue,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
return result;
|
||||||
|
}, {});
|
||||||
|
|
||||||
|
const body = {
|
||||||
|
fields: documentDataObject,
|
||||||
|
};
|
||||||
|
|
||||||
|
const { data } = await $.http.post(
|
||||||
|
`/v1/projects/${projectId}/databases/(default)/documents/${collectionId}?documentId=${documentId}`,
|
||||||
|
body,
|
||||||
|
{
|
||||||
|
additionalProperties: {
|
||||||
|
setFirestoreBaseUrl: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
$.setActionItem({
|
||||||
|
raw: data,
|
||||||
|
});
|
||||||
|
},
|
||||||
|
});
|
@@ -0,0 +1,100 @@
|
|||||||
|
import defineAction from '../../../../helpers/define-action.js';
|
||||||
|
|
||||||
|
export default defineAction({
|
||||||
|
name: 'Create Firebase Realtime Database Record',
|
||||||
|
key: 'createFirebaseRealtimeDatabaseRecord',
|
||||||
|
description: 'Creates a child object within your Firebase Realtime Database.',
|
||||||
|
arguments: [
|
||||||
|
{
|
||||||
|
label: 'Path',
|
||||||
|
key: 'path',
|
||||||
|
type: 'string',
|
||||||
|
required: true,
|
||||||
|
description:
|
||||||
|
"Indicate the path to the key of the object where the child objects to be queried are located, for example, 'foo/bar/here'.",
|
||||||
|
variables: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Convert Numerics',
|
||||||
|
key: 'convertNumerics',
|
||||||
|
type: 'dropdown',
|
||||||
|
required: false,
|
||||||
|
description:
|
||||||
|
"If any value represents a valid numerical value, whether it's an integer or a floating-point number, this field directs the database to store it as a numeric data type instead of a string.",
|
||||||
|
variables: true,
|
||||||
|
options: [
|
||||||
|
{ label: 'Yes', value: true },
|
||||||
|
{ label: 'No', value: false },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'New ID',
|
||||||
|
key: 'newId',
|
||||||
|
type: 'string',
|
||||||
|
required: false,
|
||||||
|
description:
|
||||||
|
'The key to use for this object, or leave it blank for Firebase to create one automatically.',
|
||||||
|
variables: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Data',
|
||||||
|
key: 'childData',
|
||||||
|
type: 'dynamic',
|
||||||
|
required: false,
|
||||||
|
description: '',
|
||||||
|
fields: [
|
||||||
|
{
|
||||||
|
label: 'Key',
|
||||||
|
key: 'key',
|
||||||
|
type: 'string',
|
||||||
|
required: false,
|
||||||
|
variables: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Value',
|
||||||
|
key: 'value',
|
||||||
|
type: 'string',
|
||||||
|
required: false,
|
||||||
|
variables: true,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
|
||||||
|
async run($) {
|
||||||
|
let path = $.step.parameters.path;
|
||||||
|
const { convertNumerics, newId, childData } = $.step.parameters;
|
||||||
|
|
||||||
|
if (newId) {
|
||||||
|
path = `${path}/${newId}.json`;
|
||||||
|
} else {
|
||||||
|
path = `${path}.json`;
|
||||||
|
}
|
||||||
|
|
||||||
|
const formattedChildObjectData = childData.reduce((result, entry) => {
|
||||||
|
const key = entry?.key;
|
||||||
|
const value = entry?.value;
|
||||||
|
const isNumber = !isNaN(parseFloat(value));
|
||||||
|
|
||||||
|
if (isNumber && convertNumerics) {
|
||||||
|
result[key] = parseFloat(value);
|
||||||
|
} else {
|
||||||
|
result[key] = value;
|
||||||
|
}
|
||||||
|
|
||||||
|
return result;
|
||||||
|
}, {});
|
||||||
|
|
||||||
|
const body = formattedChildObjectData;
|
||||||
|
|
||||||
|
const { data } = await $.http.post(path, body, {
|
||||||
|
additionalProperties: {
|
||||||
|
setFirestoreBaseUrl: false,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
$.setActionItem({
|
||||||
|
raw: data,
|
||||||
|
});
|
||||||
|
},
|
||||||
|
});
|
@@ -0,0 +1,53 @@
|
|||||||
|
import defineAction from '../../../../helpers/define-action.js';
|
||||||
|
|
||||||
|
export default defineAction({
|
||||||
|
name: 'Find Cloud Firestore document',
|
||||||
|
key: 'findCloudFirestoreDocument',
|
||||||
|
description: 'Finds a document within a collection.',
|
||||||
|
arguments: [
|
||||||
|
{
|
||||||
|
label: 'Collection',
|
||||||
|
key: 'collectionId',
|
||||||
|
type: 'dropdown',
|
||||||
|
required: true,
|
||||||
|
description: '',
|
||||||
|
variables: true,
|
||||||
|
source: {
|
||||||
|
type: 'query',
|
||||||
|
name: 'getDynamicData',
|
||||||
|
arguments: [
|
||||||
|
{
|
||||||
|
name: 'key',
|
||||||
|
value: 'listFirestoreCollections',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Document ID',
|
||||||
|
key: 'documentId',
|
||||||
|
type: 'string',
|
||||||
|
required: true,
|
||||||
|
description: '',
|
||||||
|
variables: true,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
|
||||||
|
async run($) {
|
||||||
|
const projectId = $.auth.data.projectId;
|
||||||
|
const { collectionId, documentId } = $.step.parameters;
|
||||||
|
|
||||||
|
const { data } = await $.http.get(
|
||||||
|
`/v1/projects/${projectId}/databases/(default)/documents/${collectionId}/${documentId}`,
|
||||||
|
{
|
||||||
|
additionalProperties: {
|
||||||
|
setFirestoreBaseUrl: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
$.setActionItem({
|
||||||
|
raw: data,
|
||||||
|
});
|
||||||
|
},
|
||||||
|
});
|
9
packages/backend/src/apps/firebase/actions/index.js
Normal file
9
packages/backend/src/apps/firebase/actions/index.js
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
import createCloudFirestoreDocument from './create-cloud-firestore-document/index.js';
|
||||||
|
import createFirebaseRealtimeDatabaseRecord from './create-firebase-realtime-database-record/index.js';
|
||||||
|
import findCloudFirestoreDocument from './find-cloud-firestore-document/index.js';
|
||||||
|
|
||||||
|
export default [
|
||||||
|
createCloudFirestoreDocument,
|
||||||
|
createFirebaseRealtimeDatabaseRecord,
|
||||||
|
findCloudFirestoreDocument,
|
||||||
|
];
|
52
packages/backend/src/apps/firebase/assets/favicon.svg
Normal file
52
packages/backend/src/apps/firebase/assets/favicon.svg
Normal file
File diff suppressed because one or more lines are too long
After Width: | Height: | Size: 21 KiB |
23
packages/backend/src/apps/firebase/auth/generate-auth-url.js
Normal file
23
packages/backend/src/apps/firebase/auth/generate-auth-url.js
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
import { URLSearchParams } from 'url';
|
||||||
|
import authScope from '../common/auth-scope.js';
|
||||||
|
|
||||||
|
export default async function generateAuthUrl($) {
|
||||||
|
const oauthRedirectUrlField = $.app.auth.fields.find(
|
||||||
|
(field) => field.key == 'oAuthRedirectUrl'
|
||||||
|
);
|
||||||
|
const redirectUri = oauthRedirectUrlField.value;
|
||||||
|
const searchParams = new URLSearchParams({
|
||||||
|
client_id: $.auth.data.clientId,
|
||||||
|
redirect_uri: redirectUri,
|
||||||
|
prompt: 'select_account',
|
||||||
|
scope: authScope.join(' '),
|
||||||
|
response_type: 'code',
|
||||||
|
access_type: 'offline',
|
||||||
|
});
|
||||||
|
|
||||||
|
const url = `https://accounts.google.com/o/oauth2/v2/auth?${searchParams.toString()}`;
|
||||||
|
|
||||||
|
await $.auth.set({
|
||||||
|
url,
|
||||||
|
});
|
||||||
|
}
|
71
packages/backend/src/apps/firebase/auth/index.js
Normal file
71
packages/backend/src/apps/firebase/auth/index.js
Normal file
@@ -0,0 +1,71 @@
|
|||||||
|
import generateAuthUrl from './generate-auth-url.js';
|
||||||
|
import verifyCredentials from './verify-credentials.js';
|
||||||
|
import refreshToken from './refresh-token.js';
|
||||||
|
import isStillVerified from './is-still-verified.js';
|
||||||
|
|
||||||
|
export default {
|
||||||
|
fields: [
|
||||||
|
{
|
||||||
|
key: 'oAuthRedirectUrl',
|
||||||
|
label: 'OAuth Redirect URL',
|
||||||
|
type: 'string',
|
||||||
|
required: true,
|
||||||
|
readOnly: true,
|
||||||
|
value: '{WEB_APP_URL}/app/firebase/connections/add',
|
||||||
|
placeholder: null,
|
||||||
|
description:
|
||||||
|
'When asked to input a redirect URL in Google Cloud, enter the URL above.',
|
||||||
|
clickToCopy: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: 'clientId',
|
||||||
|
label: 'Client ID',
|
||||||
|
type: 'string',
|
||||||
|
required: true,
|
||||||
|
readOnly: false,
|
||||||
|
value: null,
|
||||||
|
placeholder: null,
|
||||||
|
description: null,
|
||||||
|
clickToCopy: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: 'clientSecret',
|
||||||
|
label: 'Client Secret',
|
||||||
|
type: 'string',
|
||||||
|
required: true,
|
||||||
|
readOnly: false,
|
||||||
|
value: null,
|
||||||
|
placeholder: null,
|
||||||
|
description: null,
|
||||||
|
clickToCopy: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: 'projectId',
|
||||||
|
label: 'Project ID',
|
||||||
|
type: 'string',
|
||||||
|
required: true,
|
||||||
|
readOnly: false,
|
||||||
|
value: null,
|
||||||
|
placeholder: null,
|
||||||
|
description: 'The project id of your Firebase project',
|
||||||
|
clickToCopy: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: 'realtimeDatabaseId',
|
||||||
|
label: 'Realtime Database Domain',
|
||||||
|
type: 'string',
|
||||||
|
required: false,
|
||||||
|
readOnly: false,
|
||||||
|
value: null,
|
||||||
|
placeholder: null,
|
||||||
|
description:
|
||||||
|
'If you want to use Realtime Database, please provide the domain of your Realtime Database (https://{{domain}}.firebaseio.com)',
|
||||||
|
clickToCopy: false,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
|
||||||
|
generateAuthUrl,
|
||||||
|
verifyCredentials,
|
||||||
|
isStillVerified,
|
||||||
|
refreshToken,
|
||||||
|
};
|
@@ -0,0 +1,8 @@
|
|||||||
|
import getCurrentUser from '../common/get-current-user.js';
|
||||||
|
|
||||||
|
const isStillVerified = async ($) => {
|
||||||
|
const currentUser = await getCurrentUser($);
|
||||||
|
return !!currentUser.resourceName;
|
||||||
|
};
|
||||||
|
|
||||||
|
export default isStillVerified;
|
31
packages/backend/src/apps/firebase/auth/refresh-token.js
Normal file
31
packages/backend/src/apps/firebase/auth/refresh-token.js
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
import { URLSearchParams } from 'node:url';
|
||||||
|
|
||||||
|
import authScope from '../common/auth-scope.js';
|
||||||
|
|
||||||
|
const refreshToken = async ($) => {
|
||||||
|
const params = new URLSearchParams({
|
||||||
|
client_id: $.auth.data.clientId,
|
||||||
|
client_secret: $.auth.data.clientSecret,
|
||||||
|
grant_type: 'refresh_token',
|
||||||
|
refresh_token: $.auth.data.refreshToken,
|
||||||
|
});
|
||||||
|
|
||||||
|
const { data } = await $.http.post(
|
||||||
|
'https://oauth2.googleapis.com/token',
|
||||||
|
params.toString(),
|
||||||
|
{
|
||||||
|
additionalProperties: {
|
||||||
|
skipAddingAuthHeader: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
await $.auth.set({
|
||||||
|
accessToken: data.access_token,
|
||||||
|
expiresIn: data.expires_in,
|
||||||
|
scope: authScope.join(' '),
|
||||||
|
tokenType: data.token_type,
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
export default refreshToken;
|
@@ -0,0 +1,50 @@
|
|||||||
|
import getCurrentUser from '../common/get-current-user.js';
|
||||||
|
|
||||||
|
const verifyCredentials = async ($) => {
|
||||||
|
const oauthRedirectUrlField = $.app.auth.fields.find(
|
||||||
|
(field) => field.key == 'oAuthRedirectUrl'
|
||||||
|
);
|
||||||
|
const redirectUri = oauthRedirectUrlField.value;
|
||||||
|
const { data } = await $.http.post(
|
||||||
|
`https://oauth2.googleapis.com/token`,
|
||||||
|
{
|
||||||
|
client_id: $.auth.data.clientId,
|
||||||
|
client_secret: $.auth.data.clientSecret,
|
||||||
|
code: $.auth.data.code,
|
||||||
|
grant_type: 'authorization_code',
|
||||||
|
redirect_uri: redirectUri,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
additionalProperties: {
|
||||||
|
skipAddingAuthHeader: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
await $.auth.set({
|
||||||
|
accessToken: data.access_token,
|
||||||
|
tokenType: data.token_type,
|
||||||
|
});
|
||||||
|
|
||||||
|
const currentUser = await getCurrentUser($);
|
||||||
|
|
||||||
|
const { displayName } = currentUser.names.find(
|
||||||
|
(name) => name.metadata.primary
|
||||||
|
);
|
||||||
|
const { value: email } = currentUser.emailAddresses.find(
|
||||||
|
(emailAddress) => emailAddress.metadata.primary
|
||||||
|
);
|
||||||
|
|
||||||
|
await $.auth.set({
|
||||||
|
clientId: $.auth.data.clientId,
|
||||||
|
clientSecret: $.auth.data.clientSecret,
|
||||||
|
scope: $.auth.data.scope,
|
||||||
|
idToken: data.id_token,
|
||||||
|
expiresIn: data.expires_in,
|
||||||
|
refreshToken: data.refresh_token,
|
||||||
|
resourceName: currentUser.resourceName,
|
||||||
|
screenName: `${displayName} - ${email}`,
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
export default verifyCredentials;
|
@@ -0,0 +1,9 @@
|
|||||||
|
const addAuthHeader = ($, requestConfig) => {
|
||||||
|
if ($.auth.data?.accessToken) {
|
||||||
|
requestConfig.headers.Authorization = `${$.auth.data.tokenType} ${$.auth.data.accessToken}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
return requestConfig;
|
||||||
|
};
|
||||||
|
|
||||||
|
export default addAuthHeader;
|
9
packages/backend/src/apps/firebase/common/auth-scope.js
Normal file
9
packages/backend/src/apps/firebase/common/auth-scope.js
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
const authScope = [
|
||||||
|
'https://www.googleapis.com/auth/datastore',
|
||||||
|
'https://www.googleapis.com/auth/firebase.database',
|
||||||
|
'https://www.googleapis.com/auth/datastore',
|
||||||
|
'https://www.googleapis.com/auth/userinfo.email',
|
||||||
|
'https://www.googleapis.com/auth/userinfo.profile',
|
||||||
|
];
|
||||||
|
|
||||||
|
export default authScope;
|
@@ -0,0 +1,13 @@
|
|||||||
|
const getCurrentUser = async ($) => {
|
||||||
|
const { data: currentUser } = await $.http.get(
|
||||||
|
'https://people.googleapis.com/v1/people/me?personFields=names,emailAddresses',
|
||||||
|
{
|
||||||
|
additionalProperties: {
|
||||||
|
skipAddingAuthHeader: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
);
|
||||||
|
return currentUser;
|
||||||
|
};
|
||||||
|
|
||||||
|
export default getCurrentUser;
|
16
packages/backend/src/apps/firebase/common/set-base-url.js
Normal file
16
packages/backend/src/apps/firebase/common/set-base-url.js
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
const setBaseUrl = ($, requestConfig) => {
|
||||||
|
const realtimeDatabaseId = $.auth.data.realtimeDatabaseId;
|
||||||
|
|
||||||
|
if (requestConfig.additionalProperties?.skipAddingAuthHeader)
|
||||||
|
return requestConfig;
|
||||||
|
|
||||||
|
if (requestConfig.additionalProperties?.setFirestoreBaseUrl) {
|
||||||
|
requestConfig.baseURL = 'https://firestore.googleapis.com';
|
||||||
|
} else {
|
||||||
|
requestConfig.baseURL = `https://${realtimeDatabaseId}.firebaseio.com`;
|
||||||
|
}
|
||||||
|
|
||||||
|
return requestConfig;
|
||||||
|
};
|
||||||
|
|
||||||
|
export default setBaseUrl;
|
3
packages/backend/src/apps/firebase/dynamic-data/index.js
Normal file
3
packages/backend/src/apps/firebase/dynamic-data/index.js
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
import listFirestoreCollections from './list-firestore-collections/index.js';
|
||||||
|
|
||||||
|
export default [listFirestoreCollections];
|
@@ -0,0 +1,32 @@
|
|||||||
|
export default {
|
||||||
|
name: 'List firestore collections',
|
||||||
|
key: 'listFirestoreCollections',
|
||||||
|
|
||||||
|
async run($) {
|
||||||
|
const firestoreCollections = {
|
||||||
|
data: [],
|
||||||
|
};
|
||||||
|
const projectId = $.auth.data.projectId;
|
||||||
|
|
||||||
|
const { data } = await $.http.post(
|
||||||
|
`/v1/projects/${projectId}/databases/(default)/documents:listCollectionIds`,
|
||||||
|
null,
|
||||||
|
{
|
||||||
|
additionalProperties: {
|
||||||
|
setFirestoreBaseUrl: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
if (data.collectionIds?.length) {
|
||||||
|
for (const collectionId of data.collectionIds) {
|
||||||
|
firestoreCollections.data.push({
|
||||||
|
value: collectionId,
|
||||||
|
name: collectionId,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return firestoreCollections;
|
||||||
|
},
|
||||||
|
};
|
23
packages/backend/src/apps/firebase/index.js
Normal file
23
packages/backend/src/apps/firebase/index.js
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
import defineApp from '../../helpers/define-app.js';
|
||||||
|
import addAuthHeader from './common/add-auth-header.js';
|
||||||
|
import auth from './auth/index.js';
|
||||||
|
import setBaseUrl from './common/set-base-url.js';
|
||||||
|
import triggers from './triggers/index.js';
|
||||||
|
import dynamicData from './dynamic-data/index.js';
|
||||||
|
import actions from './actions/index.js';
|
||||||
|
|
||||||
|
export default defineApp({
|
||||||
|
name: 'Firebase',
|
||||||
|
key: 'firebase',
|
||||||
|
baseUrl: 'https://firebase.google.com',
|
||||||
|
apiBaseUrl: '',
|
||||||
|
iconUrl: '{BASE_URL}/apps/firebase/assets/favicon.svg',
|
||||||
|
authDocUrl: 'https://automatisch.io/docs/apps/firebase/connection',
|
||||||
|
primaryColor: 'FFA000',
|
||||||
|
supportsConnections: true,
|
||||||
|
beforeRequest: [setBaseUrl, addAuthHeader],
|
||||||
|
auth,
|
||||||
|
triggers,
|
||||||
|
dynamicData,
|
||||||
|
actions,
|
||||||
|
});
|
7
packages/backend/src/apps/firebase/triggers/index.js
Normal file
7
packages/backend/src/apps/firebase/triggers/index.js
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
import newChildObjectInFirebaseRealtimeDatabase from './new-child-object-in-a-firebase-realtime-database/index.js';
|
||||||
|
import newDocumentsWithinFirestoreCollection from './new-documents-within-firestore-collection/index.js';
|
||||||
|
|
||||||
|
export default [
|
||||||
|
newChildObjectInFirebaseRealtimeDatabase,
|
||||||
|
newDocumentsWithinFirestoreCollection,
|
||||||
|
];
|
@@ -0,0 +1,75 @@
|
|||||||
|
import Crypto from 'crypto';
|
||||||
|
import defineTrigger from '../../../../helpers/define-trigger.js';
|
||||||
|
|
||||||
|
export default defineTrigger({
|
||||||
|
name: 'New child object in a firebase realtime database',
|
||||||
|
key: 'newChildObjectInFirebaseRealtimeDatabase',
|
||||||
|
pollInterval: 15,
|
||||||
|
description:
|
||||||
|
'Triggers when a new child object is generated within a specific path.',
|
||||||
|
arguments: [
|
||||||
|
{
|
||||||
|
label: 'Path',
|
||||||
|
key: 'path',
|
||||||
|
type: 'string',
|
||||||
|
required: true,
|
||||||
|
description:
|
||||||
|
"Indicate the path to the key of the object where the child objects to be queried are located, for example, 'foo/bar/here.json'.",
|
||||||
|
variables: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Order',
|
||||||
|
key: 'order',
|
||||||
|
type: 'string',
|
||||||
|
required: false,
|
||||||
|
description:
|
||||||
|
'The key or path of the child that should be utilized for comparing objects/records. If unspecified, the order of $key is used.',
|
||||||
|
variables: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Location of newest objects',
|
||||||
|
key: 'locationOfNewestObjects',
|
||||||
|
type: 'dropdown',
|
||||||
|
required: false,
|
||||||
|
description:
|
||||||
|
'Specifies whether the new 100 records are positioned at the "top" or the "bottom" of the ordering. If left unspecified, the assumption is that the bottom/last result represents the "newest objects" (limitToLast).',
|
||||||
|
variables: true,
|
||||||
|
options: [
|
||||||
|
{ label: 'Top of results', value: 'limitToFirst' },
|
||||||
|
{ label: 'Bottom of results', value: 'limitToLast' },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
|
||||||
|
async run($) {
|
||||||
|
const { path, order, locationOfNewestObjects } = $.step.parameters;
|
||||||
|
|
||||||
|
const params = {};
|
||||||
|
|
||||||
|
if (order) {
|
||||||
|
params.orderBy = `"${order}"`;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (locationOfNewestObjects) {
|
||||||
|
params[`${locationOfNewestObjects}`] = 100;
|
||||||
|
}
|
||||||
|
|
||||||
|
const { data } = await $.http.get(path, {
|
||||||
|
params,
|
||||||
|
additionalProperties: {
|
||||||
|
setFirestoreBaseUrl: false,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!data) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$.pushTriggerItem({
|
||||||
|
raw: data,
|
||||||
|
meta: {
|
||||||
|
internalId: Crypto.randomUUID(),
|
||||||
|
},
|
||||||
|
});
|
||||||
|
},
|
||||||
|
});
|
@@ -0,0 +1,66 @@
|
|||||||
|
import defineTrigger from '../../../../helpers/define-trigger.js';
|
||||||
|
|
||||||
|
export default defineTrigger({
|
||||||
|
name: 'New documents within a firestore collection',
|
||||||
|
key: 'newDocumentsWithinFirestoreCollection',
|
||||||
|
pollInterval: 15,
|
||||||
|
description:
|
||||||
|
'Triggers when a new document is added within a Cloud Firestore collection.',
|
||||||
|
arguments: [
|
||||||
|
{
|
||||||
|
label: 'Collection',
|
||||||
|
key: 'collectionId',
|
||||||
|
type: 'dropdown',
|
||||||
|
required: true,
|
||||||
|
description: '',
|
||||||
|
variables: true,
|
||||||
|
source: {
|
||||||
|
type: 'query',
|
||||||
|
name: 'getDynamicData',
|
||||||
|
arguments: [
|
||||||
|
{
|
||||||
|
name: 'key',
|
||||||
|
value: 'listFirestoreCollections',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
|
||||||
|
async run($) {
|
||||||
|
const projectId = $.auth.data.projectId;
|
||||||
|
const collectionId = $.step.parameters.collectionId;
|
||||||
|
const params = {
|
||||||
|
pageSize: 100,
|
||||||
|
pageToken: undefined,
|
||||||
|
};
|
||||||
|
|
||||||
|
do {
|
||||||
|
const { data } = await $.http.get(
|
||||||
|
`/v1/projects/${projectId}/databases/(default)/documents/${collectionId}`,
|
||||||
|
{
|
||||||
|
params,
|
||||||
|
additionalProperties: {
|
||||||
|
setFirestoreBaseUrl: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
);
|
||||||
|
params.pageToken = data.nextPageToken;
|
||||||
|
|
||||||
|
if (!data?.documents?.length) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const document of data.documents) {
|
||||||
|
const nameParts = document.name.split('/');
|
||||||
|
const id = nameParts[nameParts.length - 1];
|
||||||
|
$.pushTriggerItem({
|
||||||
|
raw: document,
|
||||||
|
meta: {
|
||||||
|
internalId: id,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
} while (params.pageToken);
|
||||||
|
},
|
||||||
|
});
|
@@ -95,6 +95,16 @@ export default defineConfig({
|
|||||||
{ text: 'Connection', link: '/apps/filter/connection' },
|
{ text: 'Connection', link: '/apps/filter/connection' },
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
text: 'Firebase',
|
||||||
|
collapsible: true,
|
||||||
|
collapsed: true,
|
||||||
|
items: [
|
||||||
|
{ text: 'Actions', link: '/apps/firebase/actions' },
|
||||||
|
{ text: 'Triggers', link: '/apps/firebase/triggers' },
|
||||||
|
{ text: 'Connection', link: '/apps/firebase/connection' },
|
||||||
|
],
|
||||||
|
},
|
||||||
{
|
{
|
||||||
text: 'Flickr',
|
text: 'Flickr',
|
||||||
collapsible: true,
|
collapsible: true,
|
||||||
|
16
packages/docs/pages/apps/firebase/actions.md
Normal file
16
packages/docs/pages/apps/firebase/actions.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
favicon: /favicons/firebase.svg
|
||||||
|
items:
|
||||||
|
- name: Create Cloud Firestore document
|
||||||
|
desc: Creates a new document within a Cloud Firestore collection.
|
||||||
|
- name: Create Firebase Realtime Database Record
|
||||||
|
desc: Creates a child object within your Firebase Realtime Database.
|
||||||
|
- name: Find Cloud Firestore document
|
||||||
|
desc: Finds a document within a collection.
|
||||||
|
---
|
||||||
|
|
||||||
|
<script setup>
|
||||||
|
import CustomListing from '../../components/CustomListing.vue'
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<CustomListing />
|
31
packages/docs/pages/apps/firebase/connection.md
Normal file
31
packages/docs/pages/apps/firebase/connection.md
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
# Firebase
|
||||||
|
|
||||||
|
:::info
|
||||||
|
This page explains the steps you need to follow to set up the Firebase
|
||||||
|
connection in Automatisch. If any of the steps are outdated, please let us know!
|
||||||
|
:::
|
||||||
|
|
||||||
|
1. Go to the [Google Cloud Console](https://console.cloud.google.com) to create a project.
|
||||||
|
2. Click on the project drop-down menu at the top of the page, and click on the **New Project** button.
|
||||||
|
3. Enter a name for your project and click on the **Create** button.
|
||||||
|
4. Go to [API Library](https://console.cloud.google.com/apis/library) in Google Cloud console.
|
||||||
|
5. Search for **Cloud Firestore API** in the search bar and click on it.
|
||||||
|
6. Click on the **Enable** button to enable the API.
|
||||||
|
7. Repeat steps 5 and 6 for the **Firebase Realtime Database API and People API**
|
||||||
|
8. Go to [OAuth consent screen](https://console.cloud.google.com/apis/credentials/consent) in Google Cloud console.
|
||||||
|
9. Select **External** here for starting your app in testing mode at first. Click on the **Create** button.
|
||||||
|
10. Fill **App Name**, **User Support Email**, and **Developer Contact Information**. Click on the **Save and Continue** button.
|
||||||
|
11. Skip adding or removing scopes and click on the **Save and Continue** button.
|
||||||
|
12. Click on the **Add Users** button and add a test email because only test users can access the app while publishing status is set to "Testing".
|
||||||
|
13. Click on the **Save and Continue** button and now you have configured the consent screen.
|
||||||
|
14. Go to [Credentials](https://console.cloud.google.com/apis/credentials) in Google Cloud console.
|
||||||
|
15. Click on the **Create Credentials** button and select the **OAuth client ID** option.
|
||||||
|
16. Select the application type as **Web application** and fill the **Name** field.
|
||||||
|
17. Copy **OAuth Redirect URL** from Automatisch to **Authorized redirect URIs** field, and click on the **Create** button.
|
||||||
|
18. Copy the **Your Client ID** value from the following popup to the `Client ID` field on Automatisch.
|
||||||
|
19. Copy the **Your Client Secret** value from the following popup to the `Client Secret` field on Automatisch.
|
||||||
|
20. Login to your [Firebase account](https://firebase.google.com/) and go to your project (please create a new project if you don't already have one).
|
||||||
|
21. Click on the gear icon next to **Project Overview** and go to **Project settings**.
|
||||||
|
22. Copy the **Project ID** value to the `Project ID` field on Automatisch.
|
||||||
|
23. Click **Submit** button on Automatisch.
|
||||||
|
24. Congrats! Start using your new Firebase connection within the flows.
|
14
packages/docs/pages/apps/firebase/triggers.md
Normal file
14
packages/docs/pages/apps/firebase/triggers.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
---
|
||||||
|
favicon: /favicons/firebase.svg
|
||||||
|
items:
|
||||||
|
- name: New child object in a firebase realtime database
|
||||||
|
desc: Triggers when a new child object is generated within a specific path.
|
||||||
|
- name: New documents within a firestore collection
|
||||||
|
desc: Triggers when a new document is added within a Cloud Firestore collection.
|
||||||
|
---
|
||||||
|
|
||||||
|
<script setup>
|
||||||
|
import CustomListing from '../../components/CustomListing.vue'
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<CustomListing />
|
@@ -9,6 +9,7 @@ The following integrations are currently supported by Automatisch.
|
|||||||
- [Discord](/apps/discord/actions)
|
- [Discord](/apps/discord/actions)
|
||||||
- [Dropbox](/apps/dropbox/actions)
|
- [Dropbox](/apps/dropbox/actions)
|
||||||
- [Filter](/apps/filter/actions)
|
- [Filter](/apps/filter/actions)
|
||||||
|
- [Firebase](/apps/firebase/triggers)
|
||||||
- [Flickr](/apps/flickr/triggers)
|
- [Flickr](/apps/flickr/triggers)
|
||||||
- [Formatter](/apps/formatter/actions)
|
- [Formatter](/apps/formatter/actions)
|
||||||
- [Ghost](/apps/ghost/triggers)
|
- [Ghost](/apps/ghost/triggers)
|
||||||
|
52
packages/docs/pages/public/favicons/firebase.svg
Normal file
52
packages/docs/pages/public/favicons/firebase.svg
Normal file
File diff suppressed because one or more lines are too long
After Width: | Height: | Size: 21 KiB |
52
packages/docs/pages/public/favicons/firestore.svg
Normal file
52
packages/docs/pages/public/favicons/firestore.svg
Normal file
File diff suppressed because one or more lines are too long
After Width: | Height: | Size: 21 KiB |
Reference in New Issue
Block a user