diff --git a/dist-import/respostas.d.ts b/dist-import/respostas.d.ts index 8575df2..4f5955b 100644 --- a/dist-import/respostas.d.ts +++ b/dist-import/respostas.d.ts @@ -14,7 +14,7 @@ export type tipoRespostaSucesso = { detalhes?: string[]; }; export type tipoRespostaErro = { - cod: codigosResposta.erroConhecido | codigosResposta.erroDesconhecido | codigosResposta.erroPermissao; + cod: codigosResposta.erroConhecido | codigosResposta.erroDesconhecido | codigosResposta.erroPermissao | codigosResposta.erroNaoEncontrado; valor: undefined; mensagem: string; eErro: true; @@ -23,19 +23,57 @@ export type tipoRespostaErro = { }; export type tipoResposta = tipoRespostaSucesso | tipoRespostaErro; export declare const gerarRespostas: (registrarErroInterno: (erro: T) => Partial) => { + /** + * Gera uma resposta de sucesso + */ valor: (valor: T_1, detalhes?: string[]) => tipoRespostaSucesso; + /** + * Gera uma resposta de sucesso com valor true + */ valorTrue: (detalhes?: string[]) => tipoRespostaSucesso; + /** + * Gera uma resposta de erro conhecido + */ erro: (mensagem: string, detalhes?: string[]) => tipoRespostaErro; + /** + * Gera uma resposta de erro de permissão,será necessário fazer o login novamente + */ erroPermissao: (mensagem?: string | undefined | null, detalhes?: string[]) => tipoRespostaErro; + /** + * Gera uma resposta de erro desconhecido, geralmente tem origem de um exception + */ erroInterno: (parametros: T, mensagem?: string) => tipoRespostaErro; + /** + * Gera uma resposta de erro quando um registro não é encontrado ou sua execução depende de um registro existente + */ + naoEncontrado: (mensagem?: string | undefined | null, detalhes?: string[]) => tipoRespostaErro; }; /** * Uso de respostas em comuns */ export declare const respostaComuns: { + /** + * Gera uma resposta de sucesso + */ valor: (valor: T, detalhes?: string[]) => tipoRespostaSucesso; + /** + * Gera uma resposta de sucesso com valor true + */ valorTrue: (detalhes?: string[]) => tipoRespostaSucesso; + /** + * Gera uma resposta de erro conhecido + */ erro: (mensagem: string, detalhes?: string[]) => tipoRespostaErro; + /** + * Gera uma resposta de erro de permissão,será necessário fazer o login novamente + */ erroPermissao: (mensagem?: string | undefined | null, detalhes?: string[]) => tipoRespostaErro; + /** + * Gera uma resposta de erro desconhecido, geralmente tem origem de um exception + */ erroInterno: (parametros: unknown, mensagem?: string) => tipoRespostaErro; + /** + * Gera uma resposta de erro quando um registro não é encontrado ou sua execução depende de um registro existente + */ + naoEncontrado: (mensagem?: string | undefined | null, detalhes?: string[]) => tipoRespostaErro; }; diff --git a/dist-import/respostas.js b/dist-import/respostas.js index 0229d2a..8588564 100644 --- a/dist-import/respostas.js +++ b/dist-import/respostas.js @@ -7,9 +7,6 @@ export var codigosResposta; codigosResposta[codigosResposta["erroDesconhecido"] = 500] = "erroDesconhecido"; })(codigosResposta || (codigosResposta = {})); export const gerarRespostas = (registrarErroInterno) => { - /** - * Gera uma resposta de sucesso - */ const valor = (valor, detalhes) => { return { cod: codigosResposta.sucesso, @@ -20,9 +17,6 @@ export const gerarRespostas = (registrarErroInterno) => { detalhes, }; }; - /** - * Gera uma resposta de sucesso com valor true - */ const valorTrue = (detalhes) => { return { cod: codigosResposta.sucesso, @@ -33,9 +27,6 @@ export const gerarRespostas = (registrarErroInterno) => { detalhes, }; }; - /** - * Gera uma resposta de erro conhecido - */ const erro = (mensagem, detalhes) => { return { cod: codigosResposta.erroConhecido, @@ -46,9 +37,6 @@ export const gerarRespostas = (registrarErroInterno) => { detalhes, }; }; - /** - * Gera uma resposta de erro de permissão,será necessário fazer o login novamente - */ const erroPermissao = (mensagem, detalhes) => { return { cod: codigosResposta.erroPermissao, @@ -59,9 +47,17 @@ export const gerarRespostas = (registrarErroInterno) => { detalhes, }; }; - /** - * Gera uma resposta de erro desconhecido, geralmente tem origem de um exception - */ + const naoEncontrado = (mensagem, detalhes) => { + return { + cod: codigosResposta.erroNaoEncontrado, + valor: undefined, + mensagem: mensagem || + "Registro não encontrado ou a execução dessa ação depende de um registro existente.", + eErro: true, + eCerto: false, + detalhes, + }; + }; const erroInterno = (parametros, mensagem) => { const resRegistro = registrarErroInterno(parametros); const mensagemFim = `${mensagem || "Erro interno"}`; @@ -75,11 +71,30 @@ export const gerarRespostas = (registrarErroInterno) => { }; }; return { + /** + * Gera uma resposta de sucesso + */ valor, + /** + * Gera uma resposta de sucesso com valor true + */ valorTrue, + /** + * Gera uma resposta de erro conhecido + */ erro, + /** + * Gera uma resposta de erro de permissão,será necessário fazer o login novamente + */ erroPermissao, + /** + * Gera uma resposta de erro desconhecido, geralmente tem origem de um exception + */ erroInterno, + /** + * Gera uma resposta de erro quando um registro não é encontrado ou sua execução depende de um registro existente + */ + naoEncontrado, }; }; /** diff --git a/dist-require/respostas.d.ts b/dist-require/respostas.d.ts index 8575df2..4f5955b 100644 --- a/dist-require/respostas.d.ts +++ b/dist-require/respostas.d.ts @@ -14,7 +14,7 @@ export type tipoRespostaSucesso = { detalhes?: string[]; }; export type tipoRespostaErro = { - cod: codigosResposta.erroConhecido | codigosResposta.erroDesconhecido | codigosResposta.erroPermissao; + cod: codigosResposta.erroConhecido | codigosResposta.erroDesconhecido | codigosResposta.erroPermissao | codigosResposta.erroNaoEncontrado; valor: undefined; mensagem: string; eErro: true; @@ -23,19 +23,57 @@ export type tipoRespostaErro = { }; export type tipoResposta = tipoRespostaSucesso | tipoRespostaErro; export declare const gerarRespostas: (registrarErroInterno: (erro: T) => Partial) => { + /** + * Gera uma resposta de sucesso + */ valor: (valor: T_1, detalhes?: string[]) => tipoRespostaSucesso; + /** + * Gera uma resposta de sucesso com valor true + */ valorTrue: (detalhes?: string[]) => tipoRespostaSucesso; + /** + * Gera uma resposta de erro conhecido + */ erro: (mensagem: string, detalhes?: string[]) => tipoRespostaErro; + /** + * Gera uma resposta de erro de permissão,será necessário fazer o login novamente + */ erroPermissao: (mensagem?: string | undefined | null, detalhes?: string[]) => tipoRespostaErro; + /** + * Gera uma resposta de erro desconhecido, geralmente tem origem de um exception + */ erroInterno: (parametros: T, mensagem?: string) => tipoRespostaErro; + /** + * Gera uma resposta de erro quando um registro não é encontrado ou sua execução depende de um registro existente + */ + naoEncontrado: (mensagem?: string | undefined | null, detalhes?: string[]) => tipoRespostaErro; }; /** * Uso de respostas em comuns */ export declare const respostaComuns: { + /** + * Gera uma resposta de sucesso + */ valor: (valor: T, detalhes?: string[]) => tipoRespostaSucesso; + /** + * Gera uma resposta de sucesso com valor true + */ valorTrue: (detalhes?: string[]) => tipoRespostaSucesso; + /** + * Gera uma resposta de erro conhecido + */ erro: (mensagem: string, detalhes?: string[]) => tipoRespostaErro; + /** + * Gera uma resposta de erro de permissão,será necessário fazer o login novamente + */ erroPermissao: (mensagem?: string | undefined | null, detalhes?: string[]) => tipoRespostaErro; + /** + * Gera uma resposta de erro desconhecido, geralmente tem origem de um exception + */ erroInterno: (parametros: unknown, mensagem?: string) => tipoRespostaErro; + /** + * Gera uma resposta de erro quando um registro não é encontrado ou sua execução depende de um registro existente + */ + naoEncontrado: (mensagem?: string | undefined | null, detalhes?: string[]) => tipoRespostaErro; }; diff --git a/dist-require/respostas.js b/dist-require/respostas.js index 635e20c..a188c81 100644 --- a/dist-require/respostas.js +++ b/dist-require/respostas.js @@ -10,9 +10,6 @@ var codigosResposta; codigosResposta[codigosResposta["erroDesconhecido"] = 500] = "erroDesconhecido"; })(codigosResposta = exports.codigosResposta || (exports.codigosResposta = {})); const gerarRespostas = (registrarErroInterno) => { - /** - * Gera uma resposta de sucesso - */ const valor = (valor, detalhes) => { return { cod: codigosResposta.sucesso, @@ -23,9 +20,6 @@ const gerarRespostas = (registrarErroInterno) => { detalhes, }; }; - /** - * Gera uma resposta de sucesso com valor true - */ const valorTrue = (detalhes) => { return { cod: codigosResposta.sucesso, @@ -36,9 +30,6 @@ const gerarRespostas = (registrarErroInterno) => { detalhes, }; }; - /** - * Gera uma resposta de erro conhecido - */ const erro = (mensagem, detalhes) => { return { cod: codigosResposta.erroConhecido, @@ -49,9 +40,6 @@ const gerarRespostas = (registrarErroInterno) => { detalhes, }; }; - /** - * Gera uma resposta de erro de permissão,será necessário fazer o login novamente - */ const erroPermissao = (mensagem, detalhes) => { return { cod: codigosResposta.erroPermissao, @@ -62,9 +50,17 @@ const gerarRespostas = (registrarErroInterno) => { detalhes, }; }; - /** - * Gera uma resposta de erro desconhecido, geralmente tem origem de um exception - */ + const naoEncontrado = (mensagem, detalhes) => { + return { + cod: codigosResposta.erroNaoEncontrado, + valor: undefined, + mensagem: mensagem || + "Registro não encontrado ou a execução dessa ação depende de um registro existente.", + eErro: true, + eCerto: false, + detalhes, + }; + }; const erroInterno = (parametros, mensagem) => { const resRegistro = registrarErroInterno(parametros); const mensagemFim = `${mensagem || "Erro interno"}`; @@ -78,11 +74,30 @@ const gerarRespostas = (registrarErroInterno) => { }; }; return { + /** + * Gera uma resposta de sucesso + */ valor, + /** + * Gera uma resposta de sucesso com valor true + */ valorTrue, + /** + * Gera uma resposta de erro conhecido + */ erro, + /** + * Gera uma resposta de erro de permissão,será necessário fazer o login novamente + */ erroPermissao, + /** + * Gera uma resposta de erro desconhecido, geralmente tem origem de um exception + */ erroInterno, + /** + * Gera uma resposta de erro quando um registro não é encontrado ou sua execução depende de um registro existente + */ + naoEncontrado, }; }; exports.gerarRespostas = gerarRespostas; diff --git a/package.json b/package.json index 3a44878..706cf9d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "p-respostas", - "version": "0.10.0", + "version": "0.12.0", "description": "", "main": "src/index.ts", "exports": { diff --git a/src/respostas.ts b/src/respostas.ts index e834d63..7c5f881 100644 --- a/src/respostas.ts +++ b/src/respostas.ts @@ -20,6 +20,7 @@ export type tipoRespostaErro = { | codigosResposta.erroConhecido | codigosResposta.erroDesconhecido | codigosResposta.erroPermissao + | codigosResposta.erroNaoEncontrado valor: undefined mensagem: string eErro: true @@ -32,9 +33,6 @@ export type tipoResposta = tipoRespostaSucesso | tipoRespostaErro export const gerarRespostas = ( registrarErroInterno: (erro: T) => Partial, ) => { - /** - * Gera uma resposta de sucesso - */ const valor = (valor: T, detalhes?: string[]): tipoRespostaSucesso => { return { cod: codigosResposta.sucesso, @@ -46,9 +44,6 @@ export const gerarRespostas = ( } } - /** - * Gera uma resposta de sucesso com valor true - */ const valorTrue = (detalhes?: string[]): tipoRespostaSucesso => { return { cod: codigosResposta.sucesso, @@ -60,9 +55,6 @@ export const gerarRespostas = ( } } - /** - * Gera uma resposta de erro conhecido - */ const erro = (mensagem: string, detalhes?: string[]): tipoRespostaErro => { return { cod: codigosResposta.erroConhecido, @@ -74,9 +66,6 @@ export const gerarRespostas = ( } } - /** - * Gera uma resposta de erro de permissão,será necessário fazer o login novamente - */ const erroPermissao = ( mensagem?: string | undefined | null, detalhes?: string[], @@ -91,9 +80,22 @@ export const gerarRespostas = ( } } - /** - * Gera uma resposta de erro desconhecido, geralmente tem origem de um exception - */ + const naoEncontrado = ( + mensagem?: string | undefined | null, + detalhes?: string[], + ): tipoRespostaErro => { + return { + cod: codigosResposta.erroNaoEncontrado, + valor: undefined, + mensagem: + mensagem || + "Registro não encontrado ou a execução dessa ação depende de um registro existente.", + eErro: true, + eCerto: false, + detalhes, + } + } + const erroInterno = (parametros: T, mensagem?: string): tipoRespostaErro => { const resRegistro = registrarErroInterno(parametros) @@ -110,11 +112,30 @@ export const gerarRespostas = ( } return { + /** + * Gera uma resposta de sucesso + */ valor, + /** + * Gera uma resposta de sucesso com valor true + */ valorTrue, + /** + * Gera uma resposta de erro conhecido + */ erro, + /** + * Gera uma resposta de erro de permissão,será necessário fazer o login novamente + */ erroPermissao, + /** + * Gera uma resposta de erro desconhecido, geralmente tem origem de um exception + */ erroInterno, + /** + * Gera uma resposta de erro quando um registro não é encontrado ou sua execução depende de um registro existente + */ + naoEncontrado, } }