@greatapps/greatauth 0.2.0

package/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "@greatapps/greatauth",
+  "version": "0.2.0",
+  "description": "Schemas para GreatAuth (accounts, users)",
+  "main": "./src/product.js",
+  "type": "module"
+}

package/src/modules/accounts/index.js

@@ -0,0 +1,11 @@
+import { properties } from "./properties.js";
+
+export default {
+  product: "greatauth",
+  name: "accounts",
+  cache: { ttlView: 3600, ttlList: 0 },
+  summary: "Contas (tenants) globais da plataforma Great",
+  params: [],
+  properties: properties,
+  routes: {},
+};

package/src/modules/accounts/properties.js

@@ -0,0 +1,78 @@
+export const properties = {
+  id: {
+    type: "number",
+    filterable: true,
+    unique: true,
+    autoIncrement: true,
+    index: true,
+  },
+  deleted: {
+    type: "boolean",
+    default: false,
+  },
+  datetime_add: {
+    type: "date",
+    filterable: true,
+  },
+  datetime_alt: {
+    type: "date",
+    filterable: true,
+    updatable: false,
+  },
+  datetime_del: {
+    type: "date",
+    filterable: true,
+  },
+  name: {
+    type: "string",
+    searchable: true,
+    maxLength: 255,
+    interface: {
+      label: {
+        "pt-br": "Nome",
+        en: "Name",
+      },
+      description: {
+        "pt-br": "Nome da conta (tenant)",
+        en: "Account name (tenant)",
+      },
+      placeholder: {
+        "pt-br": "Nome",
+        en: "Name",
+      },
+      component: "input",
+    },
+  },
+  status: {
+    type: "string",
+    filterable: true,
+    maxLength: 20,
+    default: "active",
+    enum: ["active", "suspended", "inactive"],
+  },
+  config: {
+    type: "json",
+    default: {},
+  },
+  external_id: {
+    type: "string",
+    filterable: true,
+    maxLength: 255,
+    index: true,
+  },
+  products: {
+    type: "json",
+    default: [],
+    interface: {
+      label: {
+        "pt-br": "Produtos",
+        en: "Products",
+      },
+      description: {
+        "pt-br": "Produtos habilitados para esta conta",
+        en: "Products enabled for this account",
+      },
+      component: "select",
+    },
+  },
+};

package/src/modules/user_phones/index.js

@@ -0,0 +1,10 @@
+import { properties } from "./properties.js";
+
+export default {
+  product: "greatauth",
+  name: "user_phones",
+  cache: { ttlView: 0, ttlList: 0 },
+  params: ["id_account"],
+  properties: properties,
+  routes: {},
+};

package/src/modules/user_phones/properties.js

@@ -0,0 +1,122 @@
+export const properties = {
+  id: {
+    type: "number",
+    filterable: true,
+    unique: true,
+    autoIncrement: true,
+    index: true,
+  },
+  deleted: {
+    type: "boolean",
+    default: false,
+    filterable: true,
+  },
+  datetime_add: {
+    type: "date",
+    filterable: true,
+    updatable: false,
+  },
+  datetime_alt: {
+    type: "date",
+    filterable: true,
+    updatable: true,
+  },
+  datetime_del: {
+    type: "date",
+    filterable: true,
+  },
+  id_account: {
+    type: "number",
+    required: true,
+    updatable: false,
+    filterable: true,
+    reference: {
+      module: "accounts",
+      label: "name",
+      value: "id",
+      disabled: true,
+    },
+    interface: {
+      label: {
+        "pt-br": "Conta",
+        en: "Account",
+      },
+      component: "hidden",
+    },
+  },
+  id_user: {
+    type: "number",
+    required: true,
+    updatable: false,
+    filterable: true,
+    reference: {
+      module: "users",
+      label: "name",
+      value: "id",
+      disabled: true,
+    },
+    interface: {
+      label: {
+        "pt-br": "Usuário",
+        en: "User",
+      },
+      component: "hidden",
+    },
+  },
+  phone_number: {
+    type: "string",
+    required: true,
+    searchable: true,
+    maxLength: 50,
+    interface: {
+      label: {
+        "pt-br": "Telefone",
+        en: "Phone number",
+      },
+      component: "input",
+    },
+  },
+  label: {
+    type: "string",
+    default: "celular",
+    maxLength: 50,
+    filterable: true,
+    options: [
+      {
+        value: "celular",
+        title: { "pt-br": "Celular", en: "Mobile" },
+      },
+      {
+        value: "comercial",
+        title: { "pt-br": "Comercial", en: "Business" },
+      },
+      {
+        value: "residencial",
+        title: { "pt-br": "Residencial", en: "Home" },
+      },
+      {
+        value: "outro",
+        title: { "pt-br": "Outro", en: "Other" },
+      },
+    ],
+    interface: {
+      label: {
+        "pt-br": "Tipo",
+        en: "Label",
+      },
+      component: "select",
+    },
+  },
+  is_primary: {
+    type: "number",
+    default: 0,
+    filterable: true,
+    interface: {
+      label: {
+        "pt-br": "Principal",
+        en: "Primary",
+      },
+      component: "checkbox",
+    },
+  },
+};

package/src/modules/users/index.js

@@ -0,0 +1,10 @@
+import { properties } from "./properties.js";
+
+export default {
+  product: "greatauth",
+  name: "users",
+  cache: { ttlView: 30, ttlList: 0 },
+  params: ["id_account"],
+  properties: properties,
+  routes: {},
+};

package/src/modules/users/properties.js

@@ -0,0 +1,160 @@
+export const properties = {
+  id: {
+    type: "number",
+    filterable: true,
+    unique: true,
+    autoIncrement: true,
+    index: true,
+  },
+  deleted: {
+    type: "boolean",
+    default: false,
+    filterable: true,
+  },
+  datetime_add: {
+    type: "date",
+    filterable: true,
+    updatable: false,
+  },
+  datetime_alt: {
+    type: "date",
+    filterable: true,
+    updatable: true,
+  },
+  datetime_del: {
+    type: "date",
+    filterable: true,
+  },
+  id_account: {
+    type: "number",
+    required: true,
+    updatable: false,
+    filterable: true,
+    reference: {
+      module: "accounts",
+      label: "name",
+      value: "id",
+      disabled: true,
+    },
+    interface: {
+      label: {
+        "pt-br": "Conta",
+        en: "Account",
+      },
+      component: "select",
+      disabled: true,
+    },
+  },
+  name: {
+    type: "string",
+    searchable: true,
+    maxLength: 50,
+    interface: {
+      label: {
+        "pt-br": "Nome",
+        en: "Name",
+      },
+      component: "input",
+    },
+  },
+  last_name: {
+    type: "string",
+    searchable: true,
+    interface: {
+      label: {
+        "pt-br": "Sobrenome",
+        en: "Lastname",
+      },
+      component: "input",
+    },
+  },
+  email: {
+    type: "string",
+    required: true,
+    searchable: true,
+    filterable: true,
+    interface: {
+      label: {
+        "pt-br": "E-mail",
+        en: "E-mail",
+      },
+      component: "input",
+      format: "email",
+    },
+  },
+  password_hash: {
+    type: "string",
+    required: false,
+    filterable: false,
+    interface: {
+      label: {
+        "pt-br": "Hash da senha",
+        en: "Password hash",
+      },
+      component: "hidden",
+    },
+  },
+  profile: {
+    type: "string",
+    default: "collaborator",
+    filterable: true,
+    options: [
+      {
+        value: "viewer",
+        title: { "pt-br": "Visualizador", en: "Viewer" },
+      },
+      {
+        value: "collaborator",
+        title: { "pt-br": "Colaborador", en: "Collaborator" },
+      },
+      {
+        value: "admin",
+        title: { "pt-br": "Administrador", en: "Admin" },
+      },
+      {
+        value: "owner",
+        title: { "pt-br": "Proprietário", en: "Owner" },
+      },
+      {
+        value: "attendant",
+        title: { "pt-br": "Atendente", en: "Attendant" },
+      },
+    ],
+    interface: {
+      label: {
+        "pt-br": "Perfil de acesso",
+        en: "Profile",
+      },
+      component: "select",
+    },
+  },
+  photo: {
+    type: "string",
+    interface: {
+      label: {
+        "pt-br": "Foto",
+        en: "Photo",
+      },
+      component: "input",
+    },
+  },
+  last_login: {
+    type: "date",
+    filterable: true,
+  },
+  products: {
+    type: "json",
+    default: [],
+    interface: {
+      label: {
+        "pt-br": "Produtos",
+        en: "Products",
+      },
+      description: {
+        "pt-br": "Produtos habilitados para este usuário",
+        en: "Products enabled for this user",
+      },
+      component: "select",
+    },
+  },
+};

package/src/product.js

@@ -0,0 +1,43 @@
+/* Modules */
+
+import accounts from "./modules/accounts/index.js";
+import users from "./modules/users/index.js";
+import user_phones from "./modules/user_phones/index.js";
+
+/* Shared */
+
+import { parameters } from "./shared/parameters.js";
+import { responses } from "./shared/responses.js";
+
+/* Product */
+
+export default {
+  id: "great",
+  name: "great",
+  brand: "Great",
+  domain: "great.com.br",
+  summary: "Plataforma global de autenticação e gestão",
+  description: "Camada unificada de autenticação, usuários e contas",
+  routes: {
+    baseUrl: "/v1/:language/:id_wl/accounts/:id_account",
+    parameters: {
+      language: parameters.language,
+      id_wl: parameters.id_wl,
+      id_account: parameters.id_account,
+    },
+  },
+  modules: {
+    accounts,
+    users,
+    user_phones,
+  },
+  documentation: {
+    title: "Great Platform API",
+    description: "API para autenticação e gestão de contas/usuários",
+    contact: {
+      name: "Suporte Great",
+      email: "suporte@greatsoftwares.com.br",
+    },
+  },
+  responses: responses,
+};

package/src/shared/parameters.js

@@ -0,0 +1,17 @@
+export const parameters = {
+  language: {
+    type: "string",
+    example: "pt-br",
+    description: "Idioma da rota",
+  },
+  id_wl: {
+    type: "string",
+    example: "1",
+    description: "ID do whitelabel",
+  },
+  id_account: {
+    type: "string",
+    example: "1",
+    description: "ID da conta",
+  },
+};

package/src/shared/responses.js

@@ -0,0 +1,72 @@
+export const responses = {
+  400: {
+    description: "Requisição inválida",
+    content: {
+      "application/json": {
+        type: "object",
+        properties: {
+          status: { type: "number", options: [0, 1], value: 0 },
+          data: { type: "array", value: [] },
+          message: { type: "string", value: "Requisição inválida" },
+        },
+        required: ["status", "data"],
+      },
+    },
+  },
+  401: {
+    description: "Não autorizado",
+    content: {
+      "application/json": {
+        type: "object",
+        properties: {
+          status: { type: "number", options: [0, 1], value: 0 },
+          data: { type: "array", value: [] },
+          message: { type: "string", value: "Não autorizado" },
+        },
+        required: ["status", "data"],
+      },
+    },
+  },
+  403: {
+    description: "Acesso proibido",
+    content: {
+      "application/json": {
+        type: "object",
+        properties: {
+          status: { type: "number", options: [0, 1], value: 0 },
+          data: { type: "array", value: [] },
+          message: { type: "string", value: "Acesso proibido" },
+        },
+        required: ["status", "data"],
+      },
+    },
+  },
+  404: {
+    description: "Rota não encontrada",
+    content: {
+      "application/json": {
+        type: "object",
+        properties: {
+          status: { type: "number", options: [0, 1], value: 0 },
+          data: { type: "array", value: [] },
+          message: { type: "string", value: "Rota não encontrada" },
+        },
+        required: ["status", "data"],
+      },
+    },
+  },
+  500: {
+    description: "Erro interno do servidor",
+    content: {
+      "application/json": {
+        type: "object",
+        properties: {
+          status: { type: "number", options: [0, 1], value: 0 },
+          data: { type: "array", value: [] },
+          message: { type: "string", value: "Erro interno do servidor" },
+        },
+        required: ["status", "data"],
+      },
+    },
+  },
+};