diff --git a/apps/swirl-docs/src/components/Layout/SidebarNavigation.tsx b/apps/swirl-docs/src/components/Layout/SidebarNavigation.tsx index 8ecbb6c90..22cae29ba 100644 --- a/apps/swirl-docs/src/components/Layout/SidebarNavigation.tsx +++ b/apps/swirl-docs/src/components/Layout/SidebarNavigation.tsx @@ -10,7 +10,6 @@ import { HttpMethods } from "oas/dist/rmoas.types"; import Image from "next/image"; import Link from "next/link"; import { NavItem } from "@swirl/lib/navigation/"; -import { apiDocsNavItems } from "@swirl/lib/navigation/src/data/apiDocs.data"; import { apiSpecsNavItems } from "@swirl/lib/navigation/src/data/apiSpecs.data"; import classNames from "classnames"; import icon from "@getflip/swirl-icons/icons/ChevronRight28.svg"; @@ -193,7 +192,7 @@ export function SidebarNavigation() { > {router.asPath.includes("/api-docs") && ( <> - {process.env.NEXT_PUBLIC_DEPLOYMENT_STAGE !== "production" && ( + {/* {process.env.NEXT_PUBLIC_DEPLOYMENT_STAGE !== "production" && ( <>
- )} + )} */}

APIs diff --git a/apps/swirl-docs/src/lib/navigation/src/data/apiSpecs.data.ts b/apps/swirl-docs/src/lib/navigation/src/data/apiSpecs.data.ts index 5378d2c9e..18bd58d2f 100644 --- a/apps/swirl-docs/src/lib/navigation/src/data/apiSpecs.data.ts +++ b/apps/swirl-docs/src/lib/navigation/src/data/apiSpecs.data.ts @@ -1,285 +1,6 @@ import { NavItem } from "../navigation.model"; export const apiSpecsNavItems: NavItem[] = [ - { - title: "Branding", - url: "/api-docs/branding-api", - isRoot: true, - children: [ - { - title: "List of themes", - url: "/api-docs/branding-api#search-themes", - description: "get", - isRoot: false, - }, - { - title: "Get active theme for a user group", - url: "/api-docs/branding-api#get-theme", - description: "get", - isRoot: false, - }, - { - title: "Get pwa theme for the authenticated user.", - url: "/api-docs/branding-api#get-theme-pwa", - description: "get", - isRoot: false, - }, - { - title: "Get pwa theme for an unauthorized user.", - url: "/api-docs/branding-api#get-bootstrap-theme-pwa", - description: "get", - isRoot: false, - }, - { - title: "Get mobile theme for the authenticated user.", - url: "/api-docs/branding-api#get-theme-mobile", - description: "get", - isRoot: false, - }, - { - title: "Get mobile theme for an unauthorized user.", - url: "/api-docs/branding-api#get-bootstrap-theme-mobile", - description: "get", - isRoot: false, - }, - { - title: "Get web theme for the authenticated user.", - url: "/api-docs/branding-api#get-theme-web", - description: "get", - isRoot: false, - }, - { - title: "Get web theme for an unauthorized user.", - url: "/api-docs/branding-api#get-bootstrap-theme-web", - description: "get", - isRoot: false, - }, - { - title: "Updates the theme settings for a user group", - url: "/api-docs/branding-api#update-theme", - description: "patch", - isRoot: false, - }, - { - title: - "Reset a theme causing the user group to inherit a theme from above", - url: "/api-docs/branding-api#reset-theme", - description: "post", - isRoot: false, - }, - ], - specName: "branding.yml", - }, - { - title: "Channels", - url: "/api-docs/channels", - isRoot: true, - children: [ - { - title: "Get Assignable Users", - url: "/api-docs/channels#get-channel-assignable-users", - description: "get", - isRoot: false, - }, - { - title: "Get Assignable User Groups", - url: "/api-docs/channels#get-channel-assignable-user-groups", - description: "get", - isRoot: false, - }, - { - title: "Get Channel User Assignments", - url: "/api-docs/channels#get-channel-user-assignments", - description: "get", - isRoot: false, - }, - { - title: "Get Channel User Group Assignments", - url: "/api-docs/channels#get-channel-user-group-assignments", - description: "get", - isRoot: false, - }, - { - title: "Create User Assignment", - url: "/api-docs/channels#create-channel-user-assignment", - description: "post", - isRoot: false, - }, - { - title: "Create User Group Assignment", - url: "/api-docs/channels#create-channel-user-group-assignment", - description: "post", - isRoot: false, - }, - { - title: "Create Multiple User Group Assignments", - url: "/api-docs/channels#create-channel-user-group-assignments-batch", - description: "post", - isRoot: false, - }, - { - title: "Create Multiple User Assignments", - url: "/api-docs/channels#create-channel-user-assignments-batch", - description: "post", - isRoot: false, - }, - { - title: "Delete User Assignment", - url: "/api-docs/channels#delete-channel-user-assignment", - description: "delete", - isRoot: false, - }, - { - title: "Delete User Group Assignment", - url: "/api-docs/channels#delete-channel-user-group-assignment", - description: "delete", - isRoot: false, - }, - { - title: "Delete Multiple User Group Assignments", - url: "/api-docs/channels#delete-channel-user-group-assignments-batch", - description: "delete", - isRoot: false, - }, - { - title: "Delete Multiple User Assignments", - url: "/api-docs/channels#delete-channel-user-assignments-batch", - description: "delete", - isRoot: false, - }, - { - title: "Update User Assignment", - url: "/api-docs/channels#update-channel-user-assignment", - description: "patch", - isRoot: false, - }, - { - title: "Update Multiple User Assignments", - url: "/api-docs/channels#update-channel-user-assignments-batch", - description: "patch", - isRoot: false, - }, - ], - specName: "channels.yml", - }, - { - title: "Files", - url: "/api-docs/files", - isRoot: true, - children: [ - { - title: "Create a new file", - url: "/api-docs/files#create-file", - description: "post", - isRoot: false, - }, - { - title: "Get Metadata about an uploaded file.", - url: "/api-docs/files#get-file", - description: "get", - isRoot: false, - }, - ], - specName: "files.yml", - }, - { - title: "Organisations", - url: "/api-docs/organisations", - isRoot: true, - children: [ - { - title: "Get language settings for organisation", - url: "/api-docs/organisations#get-language-settings", - description: "get", - isRoot: false, - }, - { - title: "Update language settings for organisation", - url: "/api-docs/organisations#update-language-settings", - description: "patch", - isRoot: false, - }, - ], - specName: "organisations.yml", - }, - { - title: "Posts", - url: "/api-docs/posts", - isRoot: true, - children: [ - { - title: "Report a Comment.", - url: "/api-docs/posts#post-comment-report", - description: "post", - isRoot: false, - }, - { - title: "Create a new Post.", - url: "/api-docs/posts#create-post-v4", - description: "post", - isRoot: false, - }, - { - title: - "Get aggregated Post Count (unread and scheduled) across all channels for the calling user.", - url: "/api-docs/posts#get-aggregated-post-count", - description: "get", - isRoot: false, - }, - { - title: "Get Posts.", - url: "/api-docs/posts#get-posts-v4", - description: "get", - isRoot: false, - }, - { - title: "Get a Post.", - url: "/api-docs/posts#get-post-v4", - description: "get", - isRoot: false, - }, - { - title: "Delete multiple Posts.", - url: "/api-docs/posts#delete-posts-v4", - description: "delete", - isRoot: false, - }, - { - title: "Delete a Post.", - url: "/api-docs/posts#delete-post-v4", - description: "delete", - isRoot: false, - }, - { - title: "Modify existing Post.", - url: "/api-docs/posts#update-post-v4", - description: "patch", - isRoot: false, - }, - { - title: "Update the Post Content.", - url: "/api-docs/posts#update-post-content-v4", - description: "patch", - isRoot: false, - }, - ], - specName: "posts.yml", - }, - { - title: "Sharepoint Pages", - url: "/api-docs/sharepoint-pages", - isRoot: true, - children: [ - { - title: - "Execute a full-text search in a sharepoint site.\nSearches over the title and the body of the pages.", - url: "/api-docs/sharepoint-pages#sharepoint-pages-search", - description: "get", - isRoot: false, - }, - ], - specName: "sharepoint-pages.yml", - }, { title: "Tasks", url: "/api-docs/tasks", @@ -420,314 +141,4 @@ export const apiSpecsNavItems: NavItem[] = [ ], specName: "tasks.yml", }, - { - title: "User Group", - url: "/api-docs/user-group-api", - isRoot: true, - children: [ - { - title: "List user groups", - url: "/api-docs/user-group-api#search-user-groups", - description: "get", - isRoot: false, - }, - { - title: "Get user group details", - url: "/api-docs/user-group-api#get-user-group", - description: "get", - isRoot: false, - }, - { - title: "Search user group assignments", - url: "/api-docs/user-group-api#search-user-group-assignments", - description: "get", - isRoot: false, - }, - { - title: "Get user group assignment", - url: "/api-docs/user-group-api#get-user-group-assignment", - description: "get", - isRoot: false, - }, - { - title: "Search user group assignments grouped by user", - url: "/api-docs/user-group-api#search-user-group-assignments-aggregated-by-user", - description: "get", - isRoot: false, - }, - { - title: "Get user group assignments grouped by user", - url: "/api-docs/user-group-api#get-user-group-assignments-aggregated-by-user", - description: "get", - isRoot: false, - }, - { - title: "List of users assignable to given user group.", - url: "/api-docs/user-group-api#get-assignable-users-for-user-group", - description: "get", - isRoot: false, - }, - { - title: "Get all configured user group roles", - url: "/api-docs/user-group-api#get-all-user-group-roles", - description: "get", - isRoot: false, - }, - { - title: "Get all user group assignments for given user", - url: "/api-docs/user-group-api#search-user-group-assignments-for-single-user", - description: "get", - isRoot: false, - }, - { - title: "List assignable parent user groups", - url: "/api-docs/user-group-api#search-assignable-parent-user-groups", - description: "get", - isRoot: false, - }, - { - title: "Create user group", - url: "/api-docs/user-group-api#create-user-group", - description: "post", - isRoot: false, - }, - { - title: "Archive user group", - url: "/api-docs/user-group-api#archive-user-group", - description: "post", - isRoot: false, - }, - { - title: "Restore user group", - url: "/api-docs/user-group-api#restore-user-group", - description: "post", - isRoot: false, - }, - { - title: "Assign user to group", - url: "/api-docs/user-group-api#assign-user-to-user-group", - description: "post", - isRoot: false, - }, - { - title: "Assign multiple users to user groups", - url: "/api-docs/user-group-api#assign-users-to-user-group-batch", - description: "post", - isRoot: false, - }, - { - title: "Update user group", - url: "/api-docs/user-group-api#update-user-group", - description: "patch", - isRoot: false, - }, - { - title: "Delete user group", - url: "/api-docs/user-group-api#delete-user-group", - description: "delete", - isRoot: false, - }, - { - title: "Removes a specific user group assignment", - url: "/api-docs/user-group-api#delete-user-group-assignment", - description: "delete", - isRoot: false, - }, - { - title: "Delete multiple user group assignments", - url: "/api-docs/user-group-api#delete-user-group-assignments-batch", - description: "delete", - isRoot: false, - }, - ], - specName: "usergroups.yml", - }, - { - title: "User Management", - url: "/api-docs/user-management-api", - isRoot: true, - children: [ - { - title: "Search Users", - url: "/api-docs/user-management-api#search-users", - description: "get", - isRoot: false, - }, - { - title: "Get User Details", - url: "/api-docs/user-management-api#get-user", - description: "get", - isRoot: false, - }, - { - title: "List linkable identity providers", - url: "/api-docs/user-management-api#get-linkable-identity-providers", - description: "get", - isRoot: false, - }, - { - title: "Get linked identities for user", - url: "/api-docs/user-management-api#get-linked-identities", - description: "get", - isRoot: false, - }, - { - title: "Check if OTP is configured for a user", - url: "/api-docs/user-management-api#has-otp", - description: "get", - isRoot: false, - }, - { - title: "Check if a password is configured for a user", - url: "/api-docs/user-management-api#has-password", - description: "get", - isRoot: false, - }, - { - title: "Check if authenticated user has password", - url: "/api-docs/user-management-api#do-I-have-a-password", - description: "get", - isRoot: false, - }, - { - title: "Get email address of authenticated user", - url: "/api-docs/user-management-api#get-my-email-address", - description: "get", - isRoot: false, - }, - { - title: "Search on-leave notes for the authenticated user.", - url: "/api-docs/user-management-api#get-on-leave-notes", - description: "get", - isRoot: false, - }, - { - title: "Get on-leave note by its ID for the authenticated user.", - url: "/api-docs/user-management-api#get-on-leave-note", - description: "get", - isRoot: false, - }, - { - title: "List of mentionable users for on-leave notes.", - url: "/api-docs/user-management-api#get-mentionable-users-for-on-leave", - description: "get", - isRoot: false, - }, - { - title: "Create User", - url: "/api-docs/user-management-api#create-user", - description: "post", - isRoot: false, - }, - { - title: "Lock User", - url: "/api-docs/user-management-api#lock-user", - description: "post", - isRoot: false, - }, - { - title: "Unlock User", - url: "/api-docs/user-management-api#unlock-user", - description: "post", - isRoot: false, - }, - { - title: "Link identity to user", - url: "/api-docs/user-management-api#create-linked-identity", - description: "post", - isRoot: false, - }, - { - title: "Set password for user", - url: "/api-docs/user-management-api#change-password", - description: "post", - isRoot: false, - }, - { - title: "Send email requesting account actions", - url: "/api-docs/user-management-api#send-account-actions-email", - description: "post", - isRoot: false, - }, - { - title: "Send emails to multiple users requesting account actions", - url: "/api-docs/user-management-api#send-account-actions-emails-batch", - description: "post", - isRoot: false, - }, - { - title: "Change password of authenticated user", - url: "/api-docs/user-management-api#change-my-password", - description: "post", - isRoot: false, - }, - { - title: "Change email address of authenticated user", - url: "/api-docs/user-management-api#change-my-account-email", - description: "post", - isRoot: false, - }, - { - title: "Notifies the backend that the user is logged in.", - url: "/api-docs/user-management-api#logged-in", - description: "post", - isRoot: false, - }, - { - title: "Create On Leave Note", - url: "/api-docs/user-management-api#create-on-leave-note", - description: "post", - isRoot: false, - }, - { - title: "Update User", - url: "/api-docs/user-management-api#update-user", - description: "patch", - isRoot: false, - }, - { - title: "Update On Leave Note", - url: "/api-docs/user-management-api#update-on-leave-note", - description: "patch", - isRoot: false, - }, - { - title: "Delete User", - url: "/api-docs/user-management-api#delete-user", - description: "delete", - isRoot: false, - }, - { - title: "Delete multiple users", - url: "/api-docs/user-management-api#delete-users-batch", - description: "delete", - isRoot: false, - }, - { - title: "Delete linked identity", - url: "/api-docs/user-management-api#delete-linked-identity", - description: "delete", - isRoot: false, - }, - { - title: "Delete OTP of user", - url: "/api-docs/user-management-api#delete-otp", - description: "delete", - isRoot: false, - }, - { - title: "Delete password of user", - url: "/api-docs/user-management-api#delete-password", - description: "delete", - isRoot: false, - }, - { - title: "Delete specified on-leave note for the authenticated user.", - url: "/api-docs/user-management-api#delete-on-leave-note", - description: "delete", - isRoot: false, - }, - ], - specName: "users.yml", - }, ]; diff --git a/apps/swirl-docs/src/pages/_app.tsx b/apps/swirl-docs/src/pages/_app.tsx index bb4fb0a01..49559a0d5 100644 --- a/apps/swirl-docs/src/pages/_app.tsx +++ b/apps/swirl-docs/src/pages/_app.tsx @@ -29,4 +29,4 @@ const App = ? GetFlipDev : PasswordProtectedGetFlipDev; -export default App; +export default GetFlipDev; diff --git a/apps/swirl-docs/src/pages/api-docs/[apiSpec].tsx b/apps/swirl-docs/src/pages/api-docs/[apiSpec].tsx index 68c00f083..b48c40f2f 100644 --- a/apps/swirl-docs/src/pages/api-docs/[apiSpec].tsx +++ b/apps/swirl-docs/src/pages/api-docs/[apiSpec].tsx @@ -25,9 +25,15 @@ async function generateSpecData(spec: string): Promise { export const getStaticPaths: GetStaticPaths = async () => { const specs = createStaticPathsForSpecs() ?? []; + const filteredSpecs = specs.filter((spec) => { + if (typeof spec !== "string") { + return spec.params.apiSpec === "tasks"; + } + }); + return { fallback: false, - paths: specs, + paths: filteredSpecs, }; }; diff --git a/apps/swirl-docs/src/scripts/DeploymentStrategy/FileFetcher.ts b/apps/swirl-docs/src/scripts/DeploymentStrategy/FileFetcher.ts index 7e93b9657..e86b6a13e 100644 --- a/apps/swirl-docs/src/scripts/DeploymentStrategy/FileFetcher.ts +++ b/apps/swirl-docs/src/scripts/DeploymentStrategy/FileFetcher.ts @@ -1,6 +1,6 @@ -import path from "path"; import { FileSystemHandler } from "./FileSystemHandler"; import { GitLabAPI } from "./GitlabApi"; +import path from "path"; export type RepositoryTreeItem = { id: string; @@ -24,11 +24,11 @@ export class FileFetcher { ); } - const docs = await this.gitlabAPI.fetchFileList("docs"); + // const docs = await this.gitlabAPI.fetchFileList("docs"); - if (docs) { - await Promise.all(docs.map((doc) => this.processFileOrTree(doc))); - } + // if (docs) { + // await Promise.all(docs.map((doc) => this.processFileOrTree(doc))); + // } } private async fetchDocFiles(doc: string, root?: string) { diff --git a/apps/swirl-docs/src/scripts/DeploymentStrategy/FileOperator.ts b/apps/swirl-docs/src/scripts/DeploymentStrategy/FileOperator.ts index 799abc17e..05c13b2de 100644 --- a/apps/swirl-docs/src/scripts/DeploymentStrategy/FileOperator.ts +++ b/apps/swirl-docs/src/scripts/DeploymentStrategy/FileOperator.ts @@ -1,7 +1,7 @@ -import path from "path"; +import { DeploymentStrategy } from "."; import fs from "fs"; +import path from "path"; import { promisify } from "util"; -import { DeploymentStrategy } from "."; const renameAsync = promisify(fs.rename); const unlinkAsync = promisify(fs.unlink); @@ -59,6 +59,15 @@ export class FileOperator { private async deleteGlobalSpecs() { await this.deleteSpec("version-info.yml"); await this.deleteSpec("merged.yml"); + + // for preview + await this.deleteSpec("branding.yml"); + await this.deleteSpec("files.yml"); + await this.deleteSpec("organisations.yml"); + await this.deleteSpec("posts.yml"); + await this.deleteSpec("sharepoint-pages.yml"); + // await this.deleteSpec("usergroups.yml"); + // await this.deleteSpec("users.yml"); } private async deleteSpec(spec: string) { diff --git a/apps/swirl-docs/src/scripts/DeploymentStrategy/NavigationGenerator.ts b/apps/swirl-docs/src/scripts/DeploymentStrategy/NavigationGenerator.ts index 244d1bc40..5cf3b70f5 100644 --- a/apps/swirl-docs/src/scripts/DeploymentStrategy/NavigationGenerator.ts +++ b/apps/swirl-docs/src/scripts/DeploymentStrategy/NavigationGenerator.ts @@ -22,11 +22,17 @@ export class ApiSpecsNavigationGenerator .readdirSync(API_SPEC_PATH) .filter((file) => file.includes(".yml")); + console.log("specs", specs); + const navItems = await Promise.all( specs.map(async (spec) => await this.generateNavItems(spec)) ); - const dataString = navItems + const filteredNavItems = navItems.filter((navItem) => + navItem.title.includes("Tasks") + ); + + const dataString = filteredNavItems .map((navItem) => JSON.stringify(navItem)) .join(","); const apiSpecsData = this.createDataString(dataString); diff --git a/apps/swirl-docs/src/scripts/DeploymentStrategy/index.ts b/apps/swirl-docs/src/scripts/DeploymentStrategy/index.ts index a607f97f4..d02fffb45 100644 --- a/apps/swirl-docs/src/scripts/DeploymentStrategy/index.ts +++ b/apps/swirl-docs/src/scripts/DeploymentStrategy/index.ts @@ -1,10 +1,11 @@ -import { FileOperator } from "./FileOperator"; -import { FileFetcher } from "./FileFetcher"; import { - ApiSpecsNavigationGenerator, ApiDocsNavigationGenerator, + ApiSpecsNavigationGenerator, } from "./NavigationGenerator"; +import { FileFetcher } from "./FileFetcher"; +import { FileOperator } from "./FileOperator"; + export interface DeploymentStrategy { strategy: "production" | "staging"; fetchData(): Promise; @@ -27,10 +28,10 @@ export class ProductionDeployment implements DeploymentStrategy { async generateApiNavigation() { const apiSpecNavigationGenerator = new ApiSpecsNavigationGenerator(); - const apiDocsNavigationGenerator = new ApiDocsNavigationGenerator(); + // const apiDocsNavigationGenerator = new ApiDocsNavigationGenerator(); await apiSpecNavigationGenerator.generate(); - await apiDocsNavigationGenerator.generate(); + // await apiDocsNavigationGenerator.generate(); } } @@ -49,9 +50,9 @@ export class StagingDeployment implements DeploymentStrategy { async generateApiNavigation() { const apiSpecNavigationGenerator = new ApiSpecsNavigationGenerator(); - const apiDocsNavigationGenerator = new ApiDocsNavigationGenerator(); + // const apiDocsNavigationGenerator = new ApiDocsNavigationGenerator(); await apiSpecNavigationGenerator.generate(); - await apiDocsNavigationGenerator.generate(); + // await apiDocsNavigationGenerator.generate(); } } diff --git a/apps/swirl-docs/src/scripts/prebuild.ts b/apps/swirl-docs/src/scripts/prebuild.ts index 28882ede4..a5cceeac8 100644 --- a/apps/swirl-docs/src/scripts/prebuild.ts +++ b/apps/swirl-docs/src/scripts/prebuild.ts @@ -1,10 +1,11 @@ -import { Env } from "@swirl/lib/env/server.config"; import { DeploymentStrategy, ProductionDeployment, StagingDeployment, } from "./DeploymentStrategy"; +import { Env } from "@swirl/lib/env/server.config"; + const getDeploymentStrategy = (): DeploymentStrategy => { if (Env.NEXT_PUBLIC_DEPLOYMENT_STAGE === "production") { return new ProductionDeployment(); diff --git a/packages/swirl-icons/dart/lib/fonts/flip-legacy-icons.ttf b/packages/swirl-icons/dart/lib/fonts/flip-legacy-icons.ttf index f6f5785f4..d11fc86f0 100644 Binary files a/packages/swirl-icons/dart/lib/fonts/flip-legacy-icons.ttf and b/packages/swirl-icons/dart/lib/fonts/flip-legacy-icons.ttf differ diff --git a/packages/swirl-icons/dart/lib/fonts/swirl-icons.ttf b/packages/swirl-icons/dart/lib/fonts/swirl-icons.ttf index 075466bdb..fd070655b 100644 Binary files a/packages/swirl-icons/dart/lib/fonts/swirl-icons.ttf and b/packages/swirl-icons/dart/lib/fonts/swirl-icons.ttf differ diff --git a/packages/swirl-tokens/dart/lib/styles.dark.dart b/packages/swirl-tokens/dart/lib/styles.dark.dart index f1b5c6ac4..cce103f25 100644 --- a/packages/swirl-tokens/dart/lib/styles.dark.dart +++ b/packages/swirl-tokens/dart/lib/styles.dark.dart @@ -4,7 +4,7 @@ // // Do not edit directly -// Generated on Wed, 15 Nov 2023 10:24:31 GMT +// Generated on Wed, 15 Nov 2023 11:53:17 GMT diff --git a/packages/swirl-tokens/dart/lib/styles.light.dart b/packages/swirl-tokens/dart/lib/styles.light.dart index f7c178196..4a4755dbb 100644 --- a/packages/swirl-tokens/dart/lib/styles.light.dart +++ b/packages/swirl-tokens/dart/lib/styles.light.dart @@ -4,7 +4,7 @@ // // Do not edit directly -// Generated on Wed, 15 Nov 2023 10:24:31 GMT +// Generated on Wed, 15 Nov 2023 11:53:17 GMT