add new source providers

add google calendar source provider
zoolanders · Jan 10, 2024 · f442d6b · f442d6b
1 parent cc4b1b8
commit f442d6b
Show file tree

Hide file tree

Showing 11 changed files with 405 additions and 0 deletions.
diff --git a/public/assets/ytp/auths/driver-airtable-access-token.webp b/public/assets/ytp/auths/driver-airtable-access-token.webp
diff --git a/public/assets/ytp/sources/airtable-config.webp b/public/assets/ytp/sources/airtable-config.webp
diff --git a/public/assets/ytp/sources/google-calendar-config.webp b/public/assets/ytp/sources/google-calendar-config.webp
diff --git a/public/assets/ytp/sources/google-photos-config.webp b/public/assets/ytp/sources/google-photos-config.webp
diff --git a/src/assets/ytp-auth.afphoto b/src/assets/ytp-auth.afphoto
diff --git a/src/assets/ytp-sources.afphoto b/src/assets/ytp-sources.afphoto
diff --git a/src/pages/essentials-for-yootheme-pro/addons/sources/nav.json b/src/pages/essentials-for-yootheme-pro/addons/sources/nav.json
@@ -46,6 +46,10 @@
                     "title": "Database",
                     "href": "./providers/database"
                 },
+                {
+                    "title": "Airtable",
+                    "href": "./providers/airtable"
+                },
                 {
                     "title": "Google Sheet",
                     "href": "./providers/google-sheet"
@@ -105,6 +109,14 @@
                 {
                     "title": "Google Business Profile",
                     "href": "./providers/google-business-profile"
+                },
+                {
+                    "title": "Google Calendar",
+                    "href": "./providers/google-calendar"
+                },
+                {
+                    "title": "Google Photos",
+                    "href": "./providers/google-photos"
                 }
             ]
         },

diff --git a/src/pages/essentials-for-yootheme-pro/addons/sources/providers/airtable.md b/src/pages/essentials-for-yootheme-pro/addons/sources/providers/airtable.md
@@ -0,0 +1,69 @@
+---
+title: Airtable
+description: Content Source based on Airtable apps
+icon: '
+    <path stroke="none" d="m2.733 10.771-.026-.001a.698.698 0 0 0-.495.206.635.635 0 0 0-.212.437v9.053a.69.69 0 0 0 .987.582l-.004.002 7.125-3.416 3.216-1.555a.646.646 0 0 0-.062-1.181l-.004-.002-10.302-4.08a.616.616 0 0 0-.223-.047h-.001l.001.002ZM27.349 10.728a.637.637 0 0 0-.244.05l.004-.001-10.846 4.2a.664.664 0 0 0-.411.611v9.637a.65.65 0 0 0 .893.596l-.004.002 10.847-4.214a.632.632 0 0 0 .412-.592v-9.642a.65.65 0 0 0-.65-.646l-.001-.001ZM14.991 4.131c-.5 0-.977.102-1.41.287l.023-.009-9.677 4.002a.653.653 0 0 0 .009 1.207l.004.002 9.73 3.854a3.536 3.536 0 0 0 2.681-.008l-.023.008 9.729-3.854a.655.655 0 0 0 .018-1.206l-.005-.002-9.702-4.002a3.474 3.474 0 0 0-1.374-.278h-.005l.002-.001Z"/>
+'
+---
+
+{% elementIcon draw=$markdoc.frontmatter.icon /%}
+
+{% $markdoc.frontmatter.description %}. {% .lead %}
+
+The Airtable Source feeds data from Airtable platform. Based on the [multi-instance](/essentials-for-yootheme-pro/addons/sources/multi-instance-sources/) source workflow it allows connecting to multiple accounts with different configurations.
+
+---
+
+## Settings
+
+The source settings determines the content structure, every time the instance is saved the structure will be regenerated.
+
+{% image %}
+![Google Sheet Instance Configuration](/assets/ytp/sources/airtable-config.webp)
+{% /image %}
+
+| Setting | Description | Required |
+| ------- | ----------- | :------: |
+| **Account** | The Airtable Account which to authenticate with. | &#x2713; |
+| **Base** | The Airtable base which to retrieve the data from. | &#x2713; |
+| **Table** | The Airtable base table which data to create the source with. | &#x2713; |
+
+{% partial file="ytp-sources-common-settings.md" variables={name: "Airtable"} /%}
+
+---
+
+### Authentication
+
+Authentication is based on the Airtable Personal Access Token driven by the [Airtable Token Driver](/essentials-for-yootheme-pro/auth/drivers/airtable-access-token).
+
+{% image %}
+![Airtable Access Token Driver](/assets/ytp/auths/driver-airtable-access-token.webp)
+{% /image %}
+
+---
+
+## Content Queries
+
+For every source instance the following content queries will be made available as Dynamic Content option.
+
+### Record Query
+
+Fetches a single record from the Airtable base table and resolves to a dynamically generated list of record type based on the table schema.
+
+| Setting | Default | Description |
+| ------- | ------- | ----------- |
+| **Record ID** | | The ID of the record to query. |
+| **Cache** | `3600` | The duration in seconds before the cache is invalidated and the query re-executed. |
+
+---
+
+### Records Query
+
+Fetches a single record from the Airtable base table and resolves to a dynamically generated list of record type based on the table schema.
+
+| Setting | Default | Description |
+| ------- | ------- | ----------- |
+| **View** | | Optional table view to use instead of a raw query. |
+| **Start** | `1` | The offset applied to the query. |
+| **Quantity** | `20` | The limit applied to the query. |
+| **Cache** | `3600` | The duration in seconds before the cache is invalidated and the query re-executed. |
diff --git a/src/pages/essentials-for-yootheme-pro/addons/sources/providers/google-calendar.md b/src/pages/essentials-for-yootheme-pro/addons/sources/providers/google-calendar.md
@@ -0,0 +1,168 @@
+---
+title: Google Calendar
+description: Content Source based on Google Calendar
+icon: '
+    <path fill="none" stroke-width="2" d="M1.025 22.355V3.231c0-1.218.987-2.206 2.206-2.206h23.538c1.218 0 2.206.988 2.206 2.206v19.125l-6.62 6.62H7.646l-4.414-.001a2.207 2.207 0 0 1-2.206-2.207v-4.413Z"/>
+    <path stroke="none" fill-rule="nonzero" d="m16.753 12.162.847 1.285 1.683-1.226v8.081h1.67V9.972h-1.164l-3.036 2.19ZM13.81 14.88v-.092c.393-.212.717-.505.96-.859l.006-.009a2.331 2.331 0 0 0 .393-1.385v.004-.034c0-.524-.157-1.012-.428-1.418l.006.01a2.904 2.904 0 0 0-1.153-.997l-.018-.008a3.746 3.746 0 0 0-1.687-.361h.003a3.208 3.208 0 0 0-2.091.663l.008-.006c-.5.386-.885.9-1.108 1.493l-.008.023 1.527.636a2.13 2.13 0 0 1 .579-.889l.002-.001a1.534 1.534 0 0 1 1.083-.362h-.004l.069-.001c.409 0 .785.14 1.082.375l-.003-.003a1.209 1.209 0 0 1 .453.992v-.003l.001.056c0 .421-.197.796-.505 1.037l-.003.002a1.931 1.931 0 0 1-1.25.4h.004-.798v1.526h.89l.08-.001c.512 0 .985.173 1.36.465l-.004-.004a1.45 1.45 0 0 1 .572 1.188v-.002.03c0 .46-.21.87-.541 1.138l-.003.003a1.935 1.935 0 0 1-1.302.46h.002-.052c-.461 0-.885-.165-1.213-.44l.003.002a2.333 2.333 0 0 1-.73-1.224l-.003-.015-1.542.636a3.45 3.45 0 0 0 1.364 1.963l.01.008c.6.42 1.345.67 2.148.67H12.041c.642 0 1.248-.15 1.786-.42l-.023.011a3.22 3.22 0 0 0 1.261-1.105l.008-.012a2.88 2.88 0 0 0 .46-1.619v.003-.065a2.52 2.52 0 0 0-.49-1.497l.006.007a2.924 2.924 0 0 0-1.22-.962l-.02-.007Z"/>
+'
+---
+
+{% elementIcon draw=$markdoc.frontmatter.icon /%}
+
+{% $markdoc.frontmatter.description %}. {% .lead %}
+
+The Google Calendar source feeds data from the Google Calendar service. Based on the [multi-instance](/essentials-for-yootheme-pro/addons/sources/multi-instance-sources/) source workflow it allows connecting to multiple accounts with different configurations.
+
+---
+
+## Settings
+
+The source settings determines the content structure, every time the instance is saved the structure will be regenerated.
+
+{% image %}
+![Google Calendar Configuration](/assets/ytp/sources/google-calendar-config.webp)
+{% /image %}
+
+| Setting | Description | Required |
+| ------- | ----------- | :------: |
+| **Account** | The Google account which to authenticate with. | &#x2713; |
+| **Calendar** | The Google calendar which data to create the source with. | &#x2713; |
+
+{% partial file="ytp-sources-common-settings.md" variables={name: "Google Calendar"} /%}
+
+---
+
+### Authentication
+
+Authentication is based on the OAuth protocol driven by the [Google OAuth Driver](/essentials-for-yootheme-pro/auth/drivers/google-oauth).
+
+{% image %}
+![Google OAuth Driver](/assets/ytp/auths/driver-google-oauth.webp)
+{% /image %}
+
+---
+
+## Content Queries
+
+For every source instance the following content queries will be made available as Dynamic Content option.
+
+### Calendar Query
+
+Fetches the Calendar data resolving to a [Calendar Type](#calendar-type).
+
+| Setting | Default | Description |
+| ------- | ------- | ----------- |
+| **Cache** | `3600` | The duration in seconds before the cache is invalidated and the query re-executed. |
+
+---
+
+### Event Query
+
+Fetches a single event from the calendar and resolves to a [Event Type](#event-type).
+
+| Setting | Default | Description | Required |
+| ------- | ------- | ----------- | :------: |
+| **Event ID** | |  The ID of the event to query. | &#x2713; |
+| **Cache** | `3600` | The duration in seconds before the cache is invalidated and the query re-executed. |
+
+---
+
+### Events Query
+
+Fetches events from the calendar and resolves to a list of [Event Type](#event-type).
+
+| Setting | Default | Description |
+| ------- | ------- | ----------- |
+| **Query** | | Optionaly filter matching terms in the summary, description, location, attendee\'s displayName and attendee\'s email fields. |
+| **Single Events Only** | | Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. |
+| **Order By** | | The order by which to query the events, `Start Time (asc)` or `Updated (asc)`. |
+| **Quantity** | `250` | The maximum amount of events to query. |
+| **Time Min / Max** | |  Lower and Upper bounds (exclusive) for an event\'s start or end time to filter by. |
+| **Cache** | `3600` | The duration in seconds before the cache is invalidated and the query re-executed. |
+
+---
+
+## Content Types
+
+The content types define the mapping options for the source content.
+
+### Calendar Type
+
+Defines the mapping options of a Calendar object.
+
+| Option | Description | Type | Filters |
+| ------ | ----------- | ---- | ------- |
+| **ID** | Unique identifier of the calendar. | `String` |
+| **Summary** | Title of the calendar. | `String` | `Limit` |
+| **Description** | Description of the calendar. | `String` | `Limit` |
+| **Location** | Geographic location of the event as free-form text. | `String` | `Limit` |
+| **Time Zone** | The calendars default time zone. | `String` |
+
+---
+
+### Event Type
+
+Defines the mapping options of an Event object.
+
+| Option | Description | Type | Filters |
+| ------ | ----------- | ---- | ------- |
+| **ID** | Opaque identifier of the event. | `String` |
+| **URL** | An absolute link to the event in the Google Calendar Web UI. | `String` |
+| **Type** | Specific type of the event, `default`, `outOfOffice`, `focusTime` or `workingLocation`. | `String` |
+| **Status** | Status of the event, `confirmed`, `tentative` or `cancelled`. -  | `String` |
+| **Visibility** | Visibility of the event, `default`, `public`, `private`, or `confidential`  | `String` |
+| **Summary** | Title of the event. | `String` | `Limit` |
+| **Description** | Description of the calendar. | `String` | `Limit` |
+| **Location** | Geographic location of the event as free-form text. | `String` | `Limit` |
+| **Start** | The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. | `String` | `Date` |
+| **End** | The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. | `String` | `Date` |
+| **Created** | Creation time of the event. | `String` | `Date` |
+| **Updated** | Last modification time of the event. | `String` | `Date` |
+| **Creator** | The creator of the event. | [Profile Type](#profile-type) |
+| **Organizer** | The organizer of the event. | [Profile Type](#profile-type) |
+| **Attendees** | The attendees of the event. | [Attendee Type](#attendee-type) |
+| **Attachments** | File attachments of the event. | [Attachment Type](#attachment-type) |
+
+---
+
+### Profile Type
+
+Defines the mapping options of a Profile object.
+
+| Option | Description | Type | Filters |
+| ------ | ----------- | ---- | ------- |
+| **ID** | Identifier of the profile. | `String` |
+| **Email** | The profile's email. | `String` |
+| **Name** | The profile's name. | `String` | `Limit` |
+
+---
+
+### Attendee Type
+
+Defines the mapping options of an Attendee object.
+
+| Option | Description | Type | Filters |
+| ------ | ----------- | ---- | ------- |
+| **ID** | Identifier of the attendee. | `String` |
+| **Email** | The attendee's email. | `String` |
+| **Name** | The attendee's name. | `String` | `Limit` |
+| **Comment** | The attendee's name. | `String` | `Limit` |
+| **Response Status** | The attendee's response status, `needsAction`, `declined`, `tentative` or `accepted`. | `String` |
+| **Is Organizer** | Whether the attendee is the organizer of the event. | `Boolean` |
+| **Is Resource** | Whether the attendee is a resource. | `Boolean` |
+| **Is Optional** | Whether this is an optional attendee. | `Boolean` |
+| **Additional Guests Count** | Number of additional guests. | `Int` |
+
+---
+
+### Attachment Type
+
+Defines the mapping options of an Attachment object.
+
+| Option | Description | Type | Filters |
+| ------ | ----------- | ---- | ------- |
+| **ID** | Identifier of the attached file. | `String` |
+| **Title** | Title of the attachment. | `String` | `Limit` |
+| **Mime Type** | Internet media type (MIME type) of the attachment. | `String` |
+| **File URL** | URL link to the attachment. | `String` |
+| **Icon URL** | URL link to the attachment's icon. | `String` |
diff --git a/src/pages/essentials-for-yootheme-pro/addons/sources/providers/google-photos.md b/src/pages/essentials-for-yootheme-pro/addons/sources/providers/google-photos.md
@@ -0,0 +1,134 @@
+---
+title: Google Photos
+description: Content Source based on Google Photos media
+icon: '
+    <path fill="none" stroke-width="2" stroke-miterlimit="2" d="M8.01 7.376A6.99 6.99 0 0 1 15 14.365V15H1.656a.635.635 0 0 1-.635-.635 6.99 6.99 0 0 1 6.99-6.99ZM22.624 8.01A6.99 6.99 0 0 1 15.635 15H15V1.656c0-.35.284-.635.635-.635a6.99 6.99 0 0 1 6.99 6.99ZM21.99 22.624A6.99 6.99 0 0 1 15 15.635V15h13.344c.35 0 .635.284.635.635a6.99 6.99 0 0 1-6.99 6.99ZM7.376 21.99A6.99 6.99 0 0 1 14.365 15H15v13.344c0 .35-.284.635-.635.635a6.99 6.99 0 0 1-6.99-6.99Z"/>
+'
+---
+
+{% elementIcon draw=$markdoc.frontmatter.icon /%}
+
+{% $markdoc.frontmatter.description %}. {% .lead %}
+
+The Google Photos source feeds media from the Google Photos service. Based on the [multi-instance](/essentials-for-yootheme-pro/addons/sources/multi-instance-sources/) source workflow it allows connecting to multiple accounts with different configurations.
+
+---
+
+## Settings
+
+The source settings determines the content structure, every time the instance is saved the structure will be regenerated.
+
+{% image %}
+![Google Photos Configuration](/assets/ytp/sources/google-photos-config.webp)
+{% /image %}
+
+| Setting | Description | Required |
+| ------- | ----------- | :------: |
+| **Account** | The Google account which to authenticate with. | &#x2713; |
+
+{% partial file="ytp-sources-common-settings.md" variables={name: "Google Photos"} /%}
+
+---
+
+### Authentication
+
+Authentication is based on the OAuth protocol driven by the [Google OAuth Driver](/essentials-for-yootheme-pro/auth/drivers/google-oauth).
+
+{% image %}
+![Google OAuth Driver](/assets/ytp/auths/driver-google-oauth.webp)
+{% /image %}
+
+---
+
+## Content Queries
+
+For every source instance the following content queries will be made available as Dynamic Content option.
+
+### Album Query
+
+Fetches a single album resolving to a [Album Type](#album-type).
+
+| Setting | Default | Description |
+| ------- | ------- | ----------- |
+| **Album ID** | |  The ID of the album to query. | &#x2713; |
+| **Cache** | `3600` | The duration in seconds before the cache is invalidated and the query re-executed. |
+
+---
+
+### Albums Query
+
+Fetches all albums from the library resolving to a list of [Album Type](#album-type).
+
+| Setting | Default | Description |
+| ------- | ------- | ----------- |
+| **Cache** | `3600` | The duration in seconds before the cache is invalidated and the query re-executed. |
+
+---
+
+### Album Media Query
+
+Fetches media from a single album resolving to a list of [Media Type](#media-type).
+
+| Setting | Default | Description |
+| ------- | ------- | ----------- |
+| **Album ID** | |  The ID of the album to query. | &#x2713; |
+| **Page Size** | |  The number of the page which to query. | &#x2713; |
+| **Cache** | `3600` | The duration in seconds before the cache is invalidated and the query re-executed. |
+
+---
+
+## Content Types
+
+The content types define the mapping options for the source content.
+
+### Album Type
+
+Defines the mapping options of an Album object.
+
+| Option | Description | Type | Filters |
+| ------ | ----------- | ---- | ------- |
+| **ID** | Unique identifier of the album. | `String` |
+| **Title** | Title of the album. | `String` | `Limit` |
+| **Cover Photo URL** | The album cover photo URL. | `String` |
+| **Total Media Count** | The album total amount of media. | `Int` |
+
+---
+
+### Media Type
+
+Defines the mapping options of a Media object.
+
+#### Media
+
+| Option | Description | Type | Filters |
+| ------ | ----------- | ---- | ------- |
+| **ID** | Opaque identifier of the media. | `String` |
+| **URL** | The path to the locally cached media file, with optionall arguments `Width` and `Height` . | `String` |
+| **Description** | Description of the media. This is shown to the user in the item's info section in the Google Photos app. | `String` | `Limit` |
+| **Filename** | Filename of the media. This is shown to the user in the item's info section in the Google Photos app. | `String` |
+| **MIME Type** | MIME type of the media. For example, `image/jpeg`. | `String` |
+
+#### Metadata
+
+| Option | Description | Type |
+| ------ | ----------- | ---- |
+| **Width** | Original width (in pixels) of the media. | `Int` |
+| **Height** | Original height (in pixels) of the media. | `Int` |
+| **Creation Time** | Time when the media was first created (not when it was uploaded to Google Photos). | `String` |
+| **Camera Brand** | Brand of the camera with which the photo was taken. | `String` |
+| **Camera Model** | Model of the camera with which the photo was taken. | `String` |
+
+#### Metadata (Video)
+
+| Option | Description | Type |
+| ------ | ----------- | ---- |
+| **Frame Rate** | Frame rate of the media in case is a video. | `Int` |
+
+#### Metadata (Photo)
+
+| Option | Description | Type |
+| ------ | ----------- | ---- |
+| **Camera ISO** | ISO of the camera with which the photo was taken. | `Int` |
+| **Focal Length** | Focal length of the camera lens with which the photo was taken. | `Int` |
+| **Aperture F** | Aperture f number of the camera lens with which the photo was taken. | `Int` |
+| **Exposure Time** | Exposure time of the camera aperture in seconds when the photo was taken. | `String` |